[ElektroARGOSBridge] add new bridge - News, events and promotions on ARGOS electro shop (#4523)

This commit is contained in:
Petr Prenghy 2025-05-09 00:23:21 +02:00 committed by GitHub
parent 67c5198cbb
commit 908937383b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -0,0 +1,656 @@
<?php
/**
*
* this code downloads the HTML page with product news from ARGOS website (https://www.i4wifi.cz), parses it, extracts key information
* about each article (title, link, date, description, images), and formats it into a structured form,
* likely for further processing, such as creating an RSS feed.
*/
class ElektroARGOSBridge extends BridgeAbstract
{
const NAME = 'Elektro ARGOS';
const URI = 'https://www.argos.cz/';
const DESCRIPTION = 'News, events and promotions on ARGOS electro shop - www.argos.cz - Czech Republic';
const MAINTAINER = 'pprenghyorg';
const CACHE_TIMEOUT = 86400;
// Only Weekly offer and Promotional letter are supported
const PARAMETERS = [
'News and articles' => [],
'Events' => [],
'Topics and Promos' => []
];
/**
* Fetches and processes data based on the selected context.
*
* This function retrieves the HTML content for the specified context's URI,
* resolves relative links within the content, and then delegates the data
* extraction to the appropriate method (currently only `collectNews` for the 'Articles' context).
*/
public function collectData()
{
$html = getSimpleHTMLDOMCached($this->getURI(), self::CACHE_TIMEOUT);
defaultLinkTo($html, static::URI);
// Router
switch ($this->queriedContext) {
case 'News and articles':
$this->collectNews($html);
break;
case 'Events':
$this->collectEvents($html);
break;
case 'Topics and Promos':
$this->collectTopic($html);
break;
}
}
/**
* Returns the icon for the bridge.
*
* @return string The icon URL.
*/
public function getURI()
{
$uri = static::URI;
// URI Router
switch ($this->queriedContext) {
case 'News and articles':
$uri .= 'akce/nabidka/';
break;
case 'Events':
$uri .= 'pobocka-praha-hostivar/akce/udalosti/';
break;
case 'Topics and Promos':
$uri .= 'pobocka-praha-hostivar/akce/temata/';
break;
}
return $uri;
}
/**
* Returns the keyword URL map for the bridge.
*
* @return string The Name.
*/
public function getKeywordUrlMap()
{
// Get the keyword URL map from the class constant
$keywordUrlMap = static::KEYWORDURLMAP;
// returns the keyword URL map
return $keywordUrlMap;
}
/**
* Returns the name for the bridge.
*
* @return string The Name.
*/
public function getName()
{
$name = static::NAME;
$name .= ($this->queriedContext) ? ' - ' . $this->queriedContext : '';
switch ($this->queriedContext) {
case 'News and articles':
break;
case 'Events':
break;
case 'Topics and Promos':
break;
}
return $name;
}
/**
* Parse most used date formats
*
* Basically strtotime doesn't convert dates correctly due to formats
* being hard to interpret. So we use the DateTime object, manually
* fixing dates and times (set to 00:00:00.000).
*
* We don't know the timezone, so just assume +00:00 (or whatever
* DateTime chooses)
*/
private function fixDate($date)
{
$df = $this->parseDateTimeFromString($date);
return date_format($df, 'U');
}
/**
* Extracts the images from the article.
*
* @param object $article The article object.
* @return array An array of image URLs.
*/
private function extractImages($article)
{
// Notice: We can have zero or more images (though it should mostly be 1)
$elements = $article->find('img');
$images = [];
foreach ($elements as $img) {
$images[] = $img->src;
}
return $images;
}
// region Weekly offer
/**
* Collects uri, timestamp, title, content and images in the product offers from the HTML and transforms to rss.
*
* @param object $html The HTML object.
* @return void
*/
private function collectNews($html)
{
// Check if page contains articles and split by class
$articles = $html->find('.com-news-feature-prerex') or
returnServerError('No articles found! Layout might have changed!');
// Articles loop
foreach ($articles as $article) {
$item = [];
// Add URI
$item['uri'] = $this->extractNewsUri($article);
// echo $item['uri'] . '<BR>';
// Add title
$item['title'] = $this->extractNewsTitle($article);
// echo $item['title'] . '<BR>';
$item['enclosures'] = $this->extractImages($article);
// Add to rss query
$this->items[] = $item;
}
}
/**
* Collects uri, timestamp, title, content and images in the promotional letter from the HTML and transforms to rss.
*
* @param object $html The HTML object.
* @return void
*/
private function collectEvents($html)
{
// Check if page contains articles and split by class
$articles = $html->find('.com-news-common-prerex') or
returnServerError('No articles found! Layout might have changed!');
// Articles loop
foreach ($articles as $article) {
$item = [];
// Add URI
$item['uri'] = $this->extractEventUri($article);
// Add title
$item['title'] = $this->extractEventTitle($article);
// Add content
$item['content'] = $this->extractEventDescription($article);
// Parse time
$newsDate = $this->extractDate($article);
// Remove prefix
$newsDate = str_replace('zveřejněno: ', '', $newsDate);
// Fix date
$item['timestamp'] = $this->fixDate($newsDate);
// Add images
$item['enclosures'] = $this->extractImages($article);
// Add to rss query
$this->items[] = $item;
}
}
/**
* Collects uri, timestamp, title, content and images in the promotional letter from the HTML and transforms to rss.
*
* @param object $html The HTML object.
* @return void
*/
private function collectTopic($html)
{
// Check if page contains articles and split by class
$articles = $html->find('.com-news-common-prerex') or
returnServerError('No articles found! Layout might have changed!');
// Articles loop
foreach ($articles as $article) {
$item = [];
// Add URI
$item['uri'] = $this->extractEventUri($article);
// Add title
$item['title'] = $this->extractEventTitle($article);
// Add content
$item['content'] = $this->extractEventDescription($article);
// Parse time
$newsDate = $this->extractDate($article);
// Remove prefix
$newsDate = str_replace('zveřejněno: ', '', $newsDate);
// Fix date
$item['timestamp'] = $this->fixDate($newsDate);
// Add images
$item['enclosures'] = $this->extractImages($article);
// Add to rss query
$this->items[] = $item;
}
}
/**
* Extracts the URI of the news article.
*
* @param object $article The article object.
* @return string The URI of the news article.
*/
private function extractEventUri($article)
{
return $article->href;
}
/**
* Extracts the URI of the news article.
*
* @param object $article The article object.
* @return string The URI of the news article.
*/
private function extractNewsUri($article)
{
// Return URI of the article
$element = $article->find('a', 0) or
returnServerError('Anchor not found!');
return $element->href;
}
/**
* Extracts the URI of the news article.
*
* @param object $article The article object.
* @return string The URI of the news article.
*/
private function extractLetterUri($article)
{
// Return URI of the article
$element = $article->find('a.ws-btn', 0);
// Element empty check
if ($element == null) {
return '';
}
return $element->href;
}
/**
* Extracts the date of the news article.
*
* @param object $article The article object.
* @return string The date of the news article.
*/
private function extractDate($article)
{
// Check if date is set
$element = $article->find('div.com-news-common-prerex__date', 0) or
returnServerError('Date not found!');
return $element->plaintext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription($article)
{
// Extract description
$element = $article->find('ul.ws-product-information__piece-description', 0)->find('li', 0) or
returnServerError('Description not found!');
return $element->innertext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription1($article)
{
// Extract description
$element = $article->find('div.ws-product-price-validity', 0)->find('div', 0) or
returnServerError('Description not found!');
return $element->innertext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription2($article)
{
// Extract description
$element = $article->find('div.ws-product-price-validity', 0)->find('div', 1) or
returnServerError('Description not found!');
return $element->innertext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription3($article)
{
// Extract description
$element = $article->find('div.ws-product-badge-text', 0);
// Check if element is not null
// If it is null, return empty string
// If it is not null, return the inner text
// This is to avoid errors when the element is not found
// and to ensure that the function always returns a string
if ($element != null) {
return $element->innertext;
} else {
return '';
}
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription4($article)
{
// Extract description
$element = $article->find('div.ws-product-price-type__value', 0);
return $element->innertext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription5($article)
{
// Extract description
$element = $article->find('div.ws-product-price-type__label', 0);
return $element->innertext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractNewsDescription6($article)
{
// Extract description
$element = $article->find('div.ws-product-price', 0)->find('div.ws-product-price-type', 1);
// Element empty check
if ($element == null) {
return '';
}
// Not null, so we can safely access the element
$element = $element->find('div.ws-product-price-type__value', 0);
return $element->innertext;
}
/**
* Extracts the description of the news article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractEventDescription($article)
{
// Extract description
$element = $article->find('.com-news-common-prerex__text', 0);
return $element->innertext;
}
/**
* Extracts the title of the news article.
*
* @param object $article The article object.
* @return string The title of the news article.
*/
private function extractNewsTitle($article)
{
// Extract title
$element = $article->find('img', 0) or
returnServerError('Title not found!');
return $element->alt;
}
/**
* Extracts the title of the news article.
*
* @param object $article The article object.
* @return string The title of the news article.
*/
private function extractEventTitle($article)
{
// Extract title
$element = $article->find('div.com-news-common-prerex__right-box', 0)->find('h3', 0)
or returnServerError('Title not found!');
return $element->plaintext;
}
/**
* Extracts the description of the letter article.
*
* @param object $article The article object.
* @return string The description of the news article.
*/
private function extractLetterDescription($article)
{
// Extract description
$element = $article->find('a', 0);
return $element;
}
/**
* It attempts to recognize the date/time format in a string and create a DateTime object.
*
* It goes through the list of defined formats and tries to apply them to the input string.
* Returns the first successfully parsed DateTime object that matches the entire string.
*
* @param string $dateString A string potentially containing a date and/or time.
* @return DateTime|null A DateTime object if successfully recognized and parsed, otherwise null.
*/
private function parseDateTimeFromString(string $dateString): ?DateTime
{
// List of common formats - YOU CAN AND SHOULD EXPAND IT according to expected inputs!
// Order may matter if the formats are ambiguous.
// It is recommended to give more specific formats (with time, full year) before more general ones.
$possibleFormats = [
// Czech formats (day.month.year)
'd.m.Y H:i:s', // 10.04.2025 10:57:47
'j.n.Y H:i:s', // 10.4.2025 10:57:47
'd. m. Y H:i:s', // 10. 04. 2025 10:57:47
'j. n. Y H:i:s', // 10. 4. 2025 10:57:47
'd.m.Y H:i', // 10.04.2025 10:57
'j.n.Y H:i', // 10.4.2025 10:57
'd. m. Y H:i', // 10. 04. 2025 10:57
'j. n. Y H:i', // 10. 4. 2025 10:57
'd.m.Y', // 10.04.2025
'j.n.Y', // 10.4.2025
'd. m. Y', // 10. 04. 2025
'j. n. Y', // 10. 4. 2025
// ISO 8601 and international formats (year-month-day)
'Y-m-d H:i:s', // 2025-04-10 10:57:47
'Y-m-d H:i', // 2025-04-10 10:57
'Y-m-d', // 2025-04-10
'YmdHis', // 20250410105747
'Ymd', // 20250410
// American formats (month/day/year) - beware of ambiguity!
'm/d/Y H:i:s', // 04/10/2025 10:57:47
'n/j/Y H:i:s', // 4/10/2025 10:57:47
'm/d/Y H:i', // 04/10/2025 10:57
'n/j/Y H:i', // 4/10/2025 10:57
'm/d/Y', // 04/10/2025
'n/j/Y', // 4/10/2025
// Standard formats (including time zone)
DateTime::ATOM, // example. 2025-04-10T10:57:47+02:00
DateTime::RFC3339, // example. 2025-04-10T10:57:47+02:00
DateTime::RFC3339_EXTENDED, // example. 2025-04-10T10:57:47.123+02:00
DateTime::RFC2822, // example. Thu, 10 Apr 2025 10:57:47 +0200
DateTime::ISO8601, // example. 2025-04-10T105747+0200
'Y-m-d\TH:i:sP', // ISO 8601 s 'T' oddělovačem
'Y-m-d\TH:i:s.uP', // ISO 8601 s mikrosekundami
// You can add more formats as needed...
// e.g. 'd-M-Y' (10-Apr-2025) - requires English locale
// e.g. 'j. F Y' (10. abren 2025) - requires Czech locale
];
// Set locale for parsing month/day names (if using F, M, l, D)
// E.g. setlocale(LC_TIME, 'cs_CZ.UTF-8'); or 'en_US.UTF-8');
foreach ($possibleFormats as $format) {
// We will try to create a DateTime object from the given format
$dateTime = DateTime::createFromFormat($format, $dateString);
// We check that the parsing was successful AND ALSO
// that there were no errors or warnings during the parsing.
// This is important to ensure that the format matches the ENTIRE string.
if ($dateTime !== false) {
$errors = DateTime::getLastErrors();
if (!($errors)) {
// Success! We found a valid format for the entire string.
return $dateTime;
}
}
}
// If no format matches or parsing failed
return null;
}
/**
* Finds values from an associative array whose keys are substrings of a given text.
*
* The function iterates through the `$map` associative array. For each key,
* it checks if that key exists as a substring within the input `$text`.
* If found, the corresponding value from the map is added to the result array.
* The search is case-sensitive and treats special characters literally.
*
* @param string $text The input text string to search within.
* @param array $map An associative array (key => value). Keys from this array will be searched for in `$text`.
* @return array An array of values whose corresponding keys were found as substrings in `$text`. Returns an empty array if no keys are found.
*/
private function findValuesByKeySubstring(string $text, array $map): array
{
$foundValues = []; // Initialize array for found values
// Iterate through each key => value pair in the map
foreach ($map as $key => $value) {
// Use strpos(), which finds the position of the first occurrence of a substring.
// Returns the position (including 0) or `false` if the substring is not found.
// We use `!== false` to correctly handle the case where the key starts at position 0.
// Cast key to string for robustness (though array keys are usually strings or ints).
// `strpos` treats special characters in the key and text literally.
// echo "Key: $key, Text: $text<BR>\n";
if (strpos($text, $key) !== false) {
// If the key was found in the text, add its corresponding value to the result array
$foundValues[] = $value;
}
}
// Return the array of found values
return $foundValues;
}
/**
* Removes Czech diacritics from a given string.
*
* This function replaces Czech characters with their ASCII equivalents.
* For example, 'á' becomes 'a', 'č' becomes 'c', etc.
*
* @param string $text The input string with Czech diacritics.
* @return string The string with Czech diacritics removed.
*/
private function removeCzechDiacritics(string $text): string
{
$czech = [
'á', 'č', 'ď', 'é', 'ě', 'í', 'ň', 'ó', 'ř', 'š', 'ť', 'ú', 'ů', 'ý', 'ž',
'Á', 'Č', 'Ď', 'É', 'Ě', 'Í', 'Ň', 'Ó', 'Ř', 'Š', 'Ť', 'Ú', 'Ů', 'Ý', 'Ž'
];
$ascii = [
'a', 'c', 'd', 'e', 'e', 'i', 'n', 'o', 'r', 's', 't', 'u', 'u', 'y', 'z',
'A', 'C', 'D', 'E', 'E', 'I', 'N', 'O', 'R', 'S', 'T', 'U', 'U', 'Y', 'Z'
];
return str_replace($czech, $ascii, $text);
}
// endregion
/**
* Creates title by clean URI by removing unwanted characters and leaves last part of the URI.
*
* @param string $text The input string with Czech diacritics.
* @return string The string with Czech diacritics removed.
*/
private function formatTitleFromURI(string $uri): string
{
// get last part of the URI
$title = basename($uri);
// Pattern: /[^\p{L}\p{N}]+/u
// [^...] - Match any character NOT in the set
// \p{L} - Any Unicode letter (including 'é', 'ü', 'ñ', etc.)
// \p{N} - Any Unicode number (0-9 and other numeric characters)
// + - Match one or more occurrences of the preceding pattern consecutively
// /u - Unicode modifier, essential for \p{} constructs
$pattern = '/[^\p{L}\p{N}]+/u';
$replacement = ' '; // Replace with a single space
// lets replace
$title = preg_replace($pattern, $replacement, $title);
// first letter to uppercase
$title = ucfirst($title);
return trim((string)$title);
}
}