yetangitu/nextcloud-apps
1
0
Fork 0
mirror of https://github.com/Yetangitu/owncloud-apps.git synced 2025-10-02 14:49:17 +02:00
Code Issues Releases Wiki Activity

files_opds v0.5.9: add calibre metadata and cover support, add new dist file

Browse source
This commit is contained in:
frankdelange 2015-01-08 02:27:36 +01:00
parent 372d10af7b
commit ede5449eec
7 changed files with 143 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
dist/files_opds-0.5.9.tar.gz vendored Normal file
View file

Binary file not shown.

9
files_opds/appinfo/database.xml
View file

@ -106,6 +106,15 @@
<length>1024</length>
</field>
<field>
<!-- cover -->
<name>cover</name>
<type>text</type>
<default></default>
<notnull>false</notnull>
<length>512</length>
</field>
<field>
<!-- rescan (rescan if passed) -->
<name>rescan</name>

2
files_opds/appinfo/info.xml
View file

@ -4,7 +4,7 @@
<name>OPDS catalog</name>
<description>Personal OPDS catalog</description>
<licence>AGPL</licence>
<version>0.5.5</version>
<version>0.5.9</version>
<author>Frank de Lange</author>
<requiremin>7.0</requiremin>
<shipped>true</shipped>

91
files_opds/lib/calibre.php Normal file
View file

@ -0,0 +1,91 @@
<?php
/**
* ownCloud - Files_Opds App
*
* @author Frank de Lange
* @copyright 2014 Frank de Lange
*
* This file is licensed under the Affero General Public License version 3 or
* later.
*/
namespace OCA\Files_Opds;
/**
* Calibre metadata class for OPDS
*/
class Calibre
{
/**
* @brief get Calibre-generated metadata
*
* @param string $path path to file
* @param arrayref $meta reference to array of metadata
* @return bool true if metadata found
*/
public static function get($path,&$meta) {
$dir = pathinfo($path)['dirname'];
$opf = $dir . '/metadata.opf';
if ((file_exists($opf)) && ($package = simplexml_load_file($opf))) {
$package->registerXPathNamespace('o', "http://www.idpf.org/2007/opf");
if(($cover = $package->xpath('//o:reference[@type="cover"]/@href')[0]) && (file_exists($dir . '/' . $cover))) {
$meta['cover'] = $cover;
}
return self::parse($package->metadata->children('dc', true),$meta);
} else {
return false;
}
}
/**
* @brief parse Calibre metadata.opf into OPDS $meta array
*
* @param SimpleXMLElement $data SimpleXMLElement object containing DC/OPF metadata
* @param arrayref &$meta
* @return bool true if metadata is valid
*/
static function parse($data,&$meta) {
foreach ($data as $key => $value) {
switch ($key) {
case 'title':
$meta['title'] = strip_tags($value);
break;
case 'creator':
if(!($author = json_decode($meta['author'],true))) {
$author = array();
}
$fileAs = $value->attributes('opf',true)->{'file-as'};
$author[(string) $fileAs] = strip_tags($value);
$meta['author'] = json_encode($author);
break;
case 'description':
$meta['description'] = strip_tags($value);
break;
case 'publisher':
$meta['publisher'] = strip_tags($value);
break;
case 'identifier':
if('ISBN' == $value->attributes('opf',true)->scheme) {
$meta['isbn'] = strip_tags($value);
}
break;
case 'subject':
if(!($subject = json_decode($meta['subjects'],true))) {
$subject = array();
}
array_push($subject,strip_tags($value));
$meta['subjects'] = json_encode($subject);
break;
case 'date':
$meta['date'] = strip_tags($value);
break;
case 'language':
$meta['language'] = strip_tags($value);
break;
}
}
return Meta::isValid($meta);
}
}

8
files_opds/lib/feed.php
View file

@ -83,6 +83,14 @@ class Feed
\OCP\User::checkLoggedIn();
\OC::$session->close();
$i = \OC\Files\Filesystem::getFileInfo($path,false);
/* check for predefined cover, if found replace $path with that of cover file */
$meta = Meta::get($i['fileid']);
if($meta['cover']) {
$path = pathinfo($path)['dirname'] .'/' . $meta['cover'];
$i = \OC\Files\Filesystem::getFileInfo($path,false);
}
if (\OC::$server->getPreviewManager()->isMimeSupported($i['mimetype'])) {
$preview = new \OC\Preview(\OC_User::getUser(), 'files');
$preview->setFile($path);

5
files_opds/lib/files.php
View file

@ -46,10 +46,15 @@ class Files extends \OCA\Files\Helper
$files = array();
/* if set, add only files with given extensions */
$fileTypes = array_filter(explode(',', strtolower(Config::get('file_types', ''))));
$skipList = array_filter(explode(',', strtolower(Config::get('skip_list', 'metadata.opf,cover.jpg'))));
foreach ($fileInfos as $i) {
if((!empty($fileTypes)) && (!in_array(strtolower(substr(strrchr($i->getName(), "."), 1)), $fileTypes))) {
continue;
}
if((!empty($skipList)) && (in_array($i->getName(),$skipList))) {
continue;
}
$files[] = self::formatFileInfo($i);
}

39
files_opds/lib/meta.php
View file

@ -40,11 +40,22 @@ class Meta
$meta['copyright'] = '';
$meta['description'] = '';
$meta['subjects'] = '';
$meta['cover'] = null;
$meta['rescan'] = null;
return $meta;
}
/**
* @brief check whether metadata is valid (ie. title, author and language are defined)
*
* @param array $meta metadata
* @return bool true if valid
*/
public static function isValid($meta) {
return (!(empty($meta['title']) || empty($meta['author']) || empty($meta['language'])));
}
/**
* @brief load metadata from database
*
@ -72,7 +83,7 @@ class Meta
$result = $query->execute($args);
$data = $result->fetchRow();
if (isset($data['id'])) {
$sql = "UPDATE *PREFIX*opds_metadata SET `updated`=?, `date`=?, `author`=?, `title`=?, `language`=?, `publisher`=?, `isbn`=?, `copyright`=?, `description`=?, `subjects`=?, `rescan`=? WHERE id=?";
$sql = "UPDATE *PREFIX*opds_metadata SET `updated`=?, `date`=?, `author`=?, `title`=?, `language`=?, `publisher`=?, `isbn`=?, `copyright`=?, `description`=?, `subjects`=?, `cover`=?, `rescan`=? WHERE id=?";
$args = array(
$meta['updated'],
$meta['date'],
@ -84,12 +95,13 @@ class Meta
$meta['copyright'],
$meta['description'],
$meta['subjects'],
$meta['cover'],
$meta['rescan'],
$meta['id']
);
} else {
$sql = "INSERT INTO *PREFIX*opds_metadata (`id`, `updated`, `date`, `author`, `title`, `language`, `publisher`, `isbn`, `copyright`, `description`, `subjects`, `rescan`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)";
$sql = "INSERT INTO *PREFIX*opds_metadata (`id`, `updated`, `date`, `author`, `title`, `language`, `publisher`, `isbn`, `copyright`, `description`, `subjects`, `cover`, `rescan`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)";
$args = array(
$meta['id'],
$meta['updated'],
@ -102,6 +114,7 @@ class Meta
$meta['copyright'],
$meta['description'],
$meta['subjects'],
$meta['cover'],
$meta['rescan']
);
}
@ -138,15 +151,20 @@ class Meta
$meta = self::create($id);
$path = \OC\Files\Filesystem::getLocalFile(\OC\Files\Filesystem::getPath($id));
/* try to call function named 'type' with signature type($path,$meta)
* eg, pdf(), epub(), etc
/* scan for Calibre-generated metadata.opf first. If found, use it as metadata source,
* if not found continue file/isbn/etc scan
*/
$type = strtolower(substr(strrchr($path, "."), 1));
if(is_callable(array(__CLASS__, $type))) {
try {
self::$type($path,$meta);
} catch (Exception $e) {
Util::logWarn("no metadata scanner for format " . $type);
if(!(Calibre::get($path,$meta))) {
/* try to call function named 'type' with signature type($path,$meta)
* eg, pdf(), epub(), etc
*/
$type = strtolower(substr(strrchr($path, "."), 1));
if(is_callable(array(__CLASS__, $type))) {
try {
self::$type($path,$meta);
} catch (Exception $e) {
Util::logWarn("no metadata scanner for format " . $type);
}
}
}
@ -157,6 +175,7 @@ class Meta
$info = pathinfo($path);
$meta['title'] = basename($path,'.'.$info['extension']);
}
self::save($meta);
return $meta;
}