MyShaarli/application/netscape/NetscapeBookmarkUtils.php

228 lines
7.5 KiB
PHP
Raw Permalink Normal View History

<?php
namespace Shaarli\Netscape;
use DateTime;
use DateTimeZone;
use Exception;
use Katzgrau\KLogger\Logger;
2023-05-24 11:35:15 +02:00
use Psr\Http\Message\UploadedFileInterface;
use Psr\Log\LogLevel;
2023-05-24 11:35:15 +02:00
use Shaarli\Bookmark\Bookmark;
use Shaarli\Bookmark\BookmarkServiceInterface;
2017-03-10 18:49:53 +01:00
use Shaarli\Config\ConfigManager;
2023-05-24 11:35:15 +02:00
use Shaarli\Formatter\BookmarkFormatter;
use Shaarli\History;
use Shaarli\NetscapeBookmarkParser\NetscapeBookmarkParser;
/**
* Utilities to import and export bookmarks using the Netscape format
*/
class NetscapeBookmarkUtils
{
2023-05-24 11:35:15 +02:00
/** @var BookmarkServiceInterface */
protected $bookmarkService;
/** @var ConfigManager */
protected $conf;
/** @var History */
protected $history;
public function __construct(BookmarkServiceInterface $bookmarkService, ConfigManager $conf, History $history)
{
$this->bookmarkService = $bookmarkService;
$this->conf = $conf;
$this->history = $history;
}
/**
2023-05-24 11:35:15 +02:00
* Filters bookmarks and adds Netscape-formatted fields
*
* Added fields:
* - timestamp link addition date, using the Unix epoch format
* - taglist comma-separated tag list
*
2023-05-24 11:35:15 +02:00
* @param BookmarkFormatter $formatter instance
* @param string $selection Which bookmarks to export: (all|private|public)
* @param bool $prependNoteUrl Prepend note permalinks with the server's URL
* @param string $indexUrl Absolute URL of the Shaarli index page
*
2023-05-24 11:35:15 +02:00
* @return array The bookmarks to be exported, with additional fields
*
2023-05-24 11:35:15 +02:00
* @throws Exception Invalid export selection
*/
2023-05-24 11:35:15 +02:00
public function filterAndFormat(
$formatter,
$selection,
$prependNoteUrl,
$indexUrl
) {
// see tpl/export.html for possible values
2023-05-24 11:35:15 +02:00
if (!in_array($selection, ['all', 'public', 'private'])) {
throw new Exception(t('Invalid export selection:') . ' "' . $selection . '"');
}
2023-05-24 11:35:15 +02:00
$bookmarkLinks = [];
foreach ($this->bookmarkService->search([], $selection)->getBookmarks() as $bookmark) {
$link = $formatter->format($bookmark);
$link['taglist'] = implode(',', $bookmark->getTags());
if ($bookmark->isNote() && $prependNoteUrl) {
$link['url'] = rtrim($indexUrl, '/') . '/' . ltrim($link['url'], '/');
}
$bookmarkLinks[] = $link;
}
return $bookmarkLinks;
}
/**
* Imports Web bookmarks from an uploaded Netscape bookmark dump
*
2023-05-24 11:35:15 +02:00
* @param array $post Server $_POST parameters
* @param UploadedFileInterface $file File in PSR-7 object format
*
* @return string Summary of the bookmark import status
*/
2023-05-24 11:35:15 +02:00
public function import($post, UploadedFileInterface $file)
{
$start = time();
2023-05-24 11:35:15 +02:00
$filename = $file->getClientFilename();
$filesize = $file->getSize();
$data = (string) $file->getStream();
if (preg_match('/<!DOCTYPE NETSCAPE-Bookmark-file-1>/i', $data) === 0) {
2023-05-24 11:35:15 +02:00
return $this->importStatus($filename, $filesize);
}
2023-05-24 11:35:15 +02:00
// Overwrite existing bookmarks?
$overwrite = !empty($post['overwrite']);
2023-05-24 11:35:15 +02:00
// Add tags to all imported bookmarks?
if (empty($post['default_tags'])) {
2023-05-24 11:35:15 +02:00
$defaultTags = [];
} else {
2023-05-24 11:35:15 +02:00
$defaultTags = tags_str2array(
escape($post['default_tags']),
$this->conf->get('general.tags_separator', ' ')
);
}
2023-05-24 11:35:15 +02:00
// Optionally Force all imported link to be either public or private.
$forcedPrivateStatus = !empty($post['privacy']) ? (string) $post['privacy'] : null;
$logger = new Logger(
2023-05-24 11:35:15 +02:00
$this->conf->get('resource.data_dir'),
!$this->conf->get('dev.debug') ? LogLevel::INFO : LogLevel::DEBUG,
[
'prefix' => 'import.',
'extension' => 'log',
]
);
2023-05-24 11:35:15 +02:00
$parser = new NetscapeBookmarkParser([], $logger);
$bookmarks = $parser->parseString($data);
$importCount = 0;
$overwriteCount = 0;
$skipCount = 0;
foreach ($bookmarks as $bkm) {
2023-05-24 11:35:15 +02:00
if ($forcedPrivateStatus == 'private') {
// all imported bookmarks are private
$isPrivate = true;
} elseif ($forcedPrivateStatus == 'public') {
// all imported bookmarks are public
$isPrivate = false;
} else {
// Use private value from imported file or default to public
$isPrivate = isset($bkm['public']) && !$bkm['public'];
}
2023-05-24 11:35:15 +02:00
$link = $this->bookmarkService->findByUrl($bkm['url']);
$existingLink = $link !== null;
if (! $existingLink) {
$link = new Bookmark();
}
if ($existingLink !== false) {
if ($overwrite === false) {
// Do not overwrite an existing link
$skipCount++;
continue;
}
2023-05-24 11:35:15 +02:00
$link->setUpdated(new DateTime());
$overwriteCount++;
2023-05-24 11:35:15 +02:00
} else {
$newLinkDate = new DateTime('@' . $bkm['dateCreated']);
$newLinkDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
$link->setCreated($newLinkDate);
}
if (!empty($defaultTags)) {
$bkm['tags'] = array_merge($defaultTags, $bkm['tags']);
}
2023-05-24 11:35:15 +02:00
$link->setTitle($bkm['name']);
$link->setUrl($bkm['url'], $this->conf->get('security.allowed_protocols'));
$link->setDescription($bkm['description']);
$link->setPrivate($isPrivate);
$link->setTags($bkm['tags']);
$this->bookmarkService->addOrSet($link, false);
$importCount++;
}
2023-05-24 11:35:15 +02:00
$this->bookmarkService->save();
$this->history->importLinks();
$duration = time() - $start;
2023-05-24 11:35:15 +02:00
return $this->importStatus(
$filename,
$filesize,
$importCount,
$overwriteCount,
$skipCount,
$duration
);
}
2023-05-24 11:35:15 +02:00
/**
* Generates an import status summary
*
* @param string $filename name of the file to import
* @param int $filesize size of the file to import
* @param int $importCount how many bookmarks were imported
* @param int $overwriteCount how many bookmarks were overwritten
* @param int $skipCount how many bookmarks were skipped
* @param int $duration how many seconds did the import take
*
* @return string Summary of the bookmark import status
*/
protected function importStatus(
$filename,
$filesize,
$importCount = 0,
$overwriteCount = 0,
$skipCount = 0,
$duration = 0
) {
$status = sprintf(t('File %s (%d bytes) '), $filename, $filesize);
if ($importCount == 0 && $overwriteCount == 0 && $skipCount == 0) {
$status .= t('has an unknown file format. Nothing was imported.');
} else {
$status .= vsprintf(
t(
'was successfully processed in %d seconds: '
. '%d bookmarks imported, %d bookmarks overwritten, %d bookmarks skipped.'
),
[$duration, $importCount, $overwriteCount, $skipCount]
);
}
return $status;
}
}