use DateTimeZone;
use Exception;
use Katzgrau\KLogger\Logger;
+use Psr\Http\Message\UploadedFileInterface;
use Psr\Log\LogLevel;
-use Shaarli\Bookmark\LinkDB;
+use Shaarli\Bookmark\Bookmark;
+use Shaarli\Bookmark\BookmarkServiceInterface;
use Shaarli\Config\ConfigManager;
+use Shaarli\Formatter\BookmarkFormatter;
use Shaarli\History;
use Shaarli\NetscapeBookmarkParser\NetscapeBookmarkParser;
/**
* Utilities to import and export bookmarks using the Netscape format
- * TODO: Not static, use a container.
*/
class NetscapeBookmarkUtils
{
+ /** @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;
+ }
/**
- * Filters links and adds Netscape-formatted fields
+ * Filters bookmarks and adds Netscape-formatted fields
*
* Added fields:
* - timestamp link addition date, using the Unix epoch format
* - taglist comma-separated tag list
*
- * @param LinkDB $linkDb Link datastore
- * @param string $selection Which links 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
+ * @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
*
- * @throws Exception Invalid export selection
+ * @return array The bookmarks to be exported, with additional fields
*
- * @return array The links to be exported, with additional fields
+ * @throws Exception Invalid export selection
*/
- public static function filterAndFormat($linkDb, $selection, $prependNoteUrl, $indexUrl)
- {
+ public function filterAndFormat(
+ $formatter,
+ $selection,
+ $prependNoteUrl,
+ $indexUrl
+ ) {
// see tpl/export.html for possible values
- if (!in_array($selection, array('all', 'public', 'private'))) {
+ if (!in_array($selection, ['all', 'public', 'private'])) {
throw new Exception(t('Invalid export selection:') . ' "' . $selection . '"');
}
- $bookmarkLinks = array();
- foreach ($linkDb as $link) {
- if ($link['private'] != 0 && $selection == 'public') {
- continue;
- }
- if ($link['private'] == 0 && $selection == 'private') {
- continue;
- }
- $date = $link['created'];
- $link['timestamp'] = $date->getTimestamp();
- $link['taglist'] = str_replace(' ', ',', $link['tags']);
-
- if (startsWith($link['url'], '?') && $prependNoteUrl) {
- $link['url'] = $indexUrl . $link['url'];
+ $bookmarkLinks = [];
+ foreach ($this->bookmarkService->search([], $selection) 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;
}
- /**
- * 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 links were imported
- * @param int $overwriteCount how many links were overwritten
- * @param int $skipCount how many links were skipped
- * @param int $duration how many seconds did the import take
- *
- * @return string Summary of the bookmark import status
- */
- private static 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 links imported, %d links overwritten, %d links skipped.'
- ),
- [$duration, $importCount, $overwriteCount, $skipCount]
- );
- }
- return $status;
- }
-
/**
* Imports Web bookmarks from an uploaded Netscape bookmark dump
*
- * @param array $post Server $_POST parameters
- * @param array $files Server $_FILES parameters
- * @param LinkDB $linkDb Loaded LinkDB instance
- * @param ConfigManager $conf instance
- * @param History $history History instance
+ * @param array $post Server $_POST parameters
+ * @param UploadedFileInterface $file File in PSR-7 object format
*
* @return string Summary of the bookmark import status
*/
- public static function import($post, $files, $linkDb, $conf, $history)
+ public function import($post, UploadedFileInterface $file)
{
$start = time();
- $filename = $files['filetoupload']['name'];
- $filesize = $files['filetoupload']['size'];
- $data = file_get_contents($files['filetoupload']['tmp_name']);
+ $filename = $file->getClientFilename();
+ $filesize = $file->getSize();
+ $data = (string) $file->getStream();
if (preg_match('/<!DOCTYPE NETSCAPE-Bookmark-file-1>/i', $data) === 0) {
- return self::importStatus($filename, $filesize);
+ return $this->importStatus($filename, $filesize);
}
- // Overwrite existing links?
+ // Overwrite existing bookmarks?
$overwrite = !empty($post['overwrite']);
- // Add tags to all imported links?
+ // Add tags to all imported bookmarks?
if (empty($post['default_tags'])) {
- $defaultTags = array();
+ $defaultTags = [];
} else {
- $defaultTags = preg_split(
- '/[\s,]+/',
- escape($post['default_tags'])
+ $defaultTags = tags_str2array(
+ escape($post['default_tags']),
+ $this->conf->get('general.tags_separator', ' ')
);
}
- // links are imported as public by default
+ // bookmarks are imported as public by default
$defaultPrivacy = 0;
$parser = new NetscapeBookmarkParser(
true, // nested tag support
$defaultTags, // additional user-specified tags
strval(1 - $defaultPrivacy), // defaultPub = 1 - defaultPrivacy
- $conf->get('resource.data_dir') // log path, will be overridden
+ $this->conf->get('resource.data_dir') // log path, will be overridden
);
$logger = new Logger(
- $conf->get('resource.data_dir'),
- !$conf->get('dev.debug') ? LogLevel::INFO : LogLevel::DEBUG,
+ $this->conf->get('resource.data_dir'),
+ !$this->conf->get('dev.debug') ? LogLevel::INFO : LogLevel::DEBUG,
[
'prefix' => 'import.',
'extension' => 'log',
// use value from the imported file
$private = $bkm['pub'] == '1' ? 0 : 1;
} elseif ($post['privacy'] == 'private') {
- // all imported links are private
+ // all imported bookmarks are private
$private = 1;
} elseif ($post['privacy'] == 'public') {
- // all imported links are public
+ // all imported bookmarks are public
$private = 0;
}
- $newLink = array(
- 'title' => $bkm['title'],
- 'url' => $bkm['uri'],
- 'description' => $bkm['note'],
- 'private' => $private,
- 'tags' => $bkm['tags']
- );
-
- $existingLink = $linkDb->getLinkFromUrl($bkm['uri']);
+ $link = $this->bookmarkService->findByUrl($bkm['uri']);
+ $existingLink = $link !== null;
+ if (! $existingLink) {
+ $link = new Bookmark();
+ }
if ($existingLink !== false) {
if ($overwrite === false) {
continue;
}
- // Overwrite an existing link, keep its date
- $newLink['id'] = $existingLink['id'];
- $newLink['created'] = $existingLink['created'];
- $newLink['updated'] = new DateTime();
- $newLink['shorturl'] = $existingLink['shorturl'];
- $linkDb[$existingLink['id']] = $newLink;
- $importCount++;
+ $link->setUpdated(new DateTime());
$overwriteCount++;
- continue;
+ } else {
+ $newLinkDate = new DateTime('@' . strval($bkm['time']));
+ $newLinkDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
+ $link->setCreated($newLinkDate);
}
- // Add a new link - @ used for UNIX timestamps
- $newLinkDate = new DateTime('@' . strval($bkm['time']));
- $newLinkDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
- $newLink['created'] = $newLinkDate;
- $newLink['id'] = $linkDb->getNextId();
- $newLink['shorturl'] = link_small_hash($newLink['created'], $newLink['id']);
- $linkDb[$newLink['id']] = $newLink;
+ $link->setTitle($bkm['title']);
+ $link->setUrl($bkm['uri'], $this->conf->get('security.allowed_protocols'));
+ $link->setDescription($bkm['note']);
+ $link->setPrivate($private);
+ $link->setTags($bkm['tags']);
+
+ $this->bookmarkService->addOrSet($link, false);
$importCount++;
}
- $linkDb->save($conf->get('resource.page_cache'));
- $history->importLinks();
+ $this->bookmarkService->save();
+ $this->history->importLinks();
$duration = time() - $start;
- return self::importStatus(
+
+ return $this->importStatus(
$filename,
$filesize,
$importCount,
$duration
);
}
+
+ /**
+ * 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;
+ }
}
projects / github / shaarli / Shaarli.git / blobdiff