gbili/webservice
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Streamline app compatibility between Solr and WS

Browse Source
This commit is contained in:
Gilles Crettenand
2015-06-02 13:33:09 +02:00
parent 1ee3aa305d
commit 018846e567
10 changed files with 765 additions and 760 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Lib/Exception/BookNotFoundException.php
View File

@@ -1,9 +1,9 @@
<?php
namespace BSR\Lib\Exception;
class BookNotFoundException extends WebException {
public function __construct($code) {
parent::__construct('BookNotFound', "The book with code $code was not found", -404);
}
}
<?php
namespace BSR\Lib\Exception;
class BookNotFoundException extends WebException {
public function __construct($code) {
parent::__construct('BookNotFound', "The book with code $code was not found", -404);
}
}

16
Lib/Exception/InvalidAttributeException.php
View File

@@ -1,8 +1,8 @@
<?php
namespace BSR\Lib\Exception;
/**
* Exception raised when an invalid attribute name is accessed
*/
class InvalidAttributeException extends \Exception { }
<?php
namespace BSR\Lib\Exception;
/**
* Exception raised when an invalid attribute name is accessed
*/
class InvalidAttributeException extends \Exception { }

38
Lib/Exception/SqlException.php
View File

@@ -1,19 +1,19 @@
<?php
namespace BSR\Lib\Exception;
class SqlException extends \Exception
{
private $query;
public function __construct($message = "Sql Error", $query = "")
{
$this->query = $query;
parent::__construct($message, 0);
}
public function getSqlError()
{
return $this->getMessage().' while executing: '.$this->query;
}
}
<?php
namespace BSR\Lib\Exception;
class SqlException extends \Exception
{
private $query;
public function __construct($message = "Sql Error", $query = "")
{
$this->query = $query;
parent::__construct($message, 0);
}
public function getSqlError()
{
return $this->getMessage().' while executing: '.$this->query;
}
}

48
Lib/Exception/WebException.php
View File

@@ -1,24 +1,24 @@
<?php
namespace BSR\Lib\Exception;
class WebException extends \Exception
{
private $excname;
/**
* @param string $name
* @param string $reason
* @param int $code
*/
function __construct($name, $reason, $code)
{
$this->excname = $name;
parent::__construct($reason, $code);
}
public function getName()
{
return $this->excname;
}
}
<?php
namespace BSR\Lib\Exception;
class WebException extends \Exception
{
private $excname;
/**
* @param string $name
* @param string $reason
* @param int $code
*/
function __construct($name, $reason, $code)
{
$this->excname = $name;
parent::__construct($reason, $code);
}
public function getName()
{
return $this->excname;
}
}

244
Lib/WebService.php
View File

@@ -1,122 +1,122 @@
<?php
namespace BSR\Lib;
use BSR\Lib\Exception\WebException;
abstract class WebService
{
private $func = null;
private $status = 200;
private $log = '';
/**
* @param $message
* @param int $verbosity
* @param bool $withTime
*/
public function log($message, $verbosity = 1, $withTime = false) {
if(Configuration::get('log.verbosity') < $verbosity) {
return;
}
if($withTime) {
$message = date("d-m-Y h:m:s").' '.$message;
}
$this->log .= $message."\n";
}
public function Run()
{
$this->log("------------------");
$this->log("Start request", 1, true);
$data = array();
try {
$result = $this->Call();
$data["result"][$this->func] = $result;
} catch (WebException $e) {
$data["error"]["code"] = $e->getCode();
$data["error"]["name"] = $e->getName();
$data["error"]["reason"] = $e->getMessage();
$this->status = 400;
$this->log(sprintf("Error : [%s] %s", $e->getCode(), $e->getName()));
} catch (\Exception $e) {
$data["failure"]["message"] = $e->getMessage();
$this->status = 500;
$this->log(sprintf("Failure : %s", $e->getMessage()));
}
$this->Send($data);
$this->log("Request finished", 1, true);
$this->log("------------------\n\n");
if(Configuration::get('log.verbosity') > 0) {
file_put_contents(Configuration::get('log.file'), $this->log, FILE_APPEND | LOCK_EX);
}
}
private function Call()
{
ob_start();
session_save_path(Configuration::get('session.save_path'));
session_start();
$params = empty($_GET) ? $_POST : $_GET;
if (empty($params)) {
throw new WebException ("CallArgument", "arguments error", -1);
}
if (!array_key_exists("func", $params)) {
throw new WebException ("CallArgFunction", "no 'func' specified", -2);
}
$this->func = $params["func"];
unset($params['func']);
if (!is_callable(array($this, $this->func))) {
throw new WebException ("CallFunction", "'func' method not available", -3);
}
$rm = new \ReflectionMethod($this, $this->func);
$nbParams = count($params);
$nbArgsFix = $rm->getNumberOfRequiredParameters();
$nbArgs = $rm->getNumberOfParameters();
/* Check the number of arguments. */
if ($nbParams < $nbArgsFix) {
throw new WebException ("CallArgNumber", "you must provide at least " . $nbArgsFix . " arguments", 4);
}
if ($nbParams > $nbArgs) {
throw new WebException ("CallArgNumber", "you must provide at most " . $nbArgs . " arguments", 4);
}
$this->log("Calling '".$this->func."'");
$this->log("Params: ".print_r($params, true), 2);
return call_user_func_array(array($this, $this->func), $params);
}
private function Send(array $data)
{
static $status_messages = array(
200 => 'Ok',
400 => 'Bad request',
404 => 'Not Found',
403 => 'Not Authorized',
500 => 'Server Error',
);
header(sprintf('HTTP/1.0 %s %s', $this->status, $status_messages[$this->status]));
ob_clean();
flush();
$this->log("Data: ".print_r($data, true), 2);
echo json_encode($data);
}
}
<?php
namespace BSR\Lib;
use BSR\Lib\Exception\WebException;
abstract class WebService
{
private $func = null;
private $status = 200;
private $log = '';
/**
* @param $message
* @param int $verbosity
* @param bool $withTime
*/
public function log($message, $verbosity = 1, $withTime = false) {
if(Configuration::get('log.verbosity') < $verbosity) {
return;
}
if($withTime) {
$message = date("d-m-Y h:m:s").' '.$message;
}
$this->log .= $message."\n";
}
public function Run()
{
$this->log("------------------");
$this->log("Start request", 1, true);
$data = array();
try {
$result = $this->Call();
$data["result"][$this->func] = $result;
} catch (WebException $e) {
$data["error"]["code"] = $e->getCode();
$data["error"]["name"] = $e->getName();
$data["error"]["reason"] = $e->getMessage();
$this->status = 400;
$this->log(sprintf("Error : [%s] %s", $e->getCode(), $e->getName()));
} catch (\Exception $e) {
$data["failure"]["message"] = $e->getMessage();
$this->status = 500;
$this->log(sprintf("Failure : %s", $e->getMessage()));
}
$this->Send($data);
$this->log("Request finished", 1, true);
$this->log("------------------\n\n");
if(Configuration::get('log.verbosity') > 0) {
file_put_contents(Configuration::get('log.file'), $this->log, FILE_APPEND | LOCK_EX);
}
}
private function Call()
{
ob_start();
session_save_path(Configuration::get('session.save_path'));
session_start();
$params = empty($_GET) ? $_POST : $_GET;
if (empty($params)) {
throw new WebException ("CallArgument", "arguments error", -1);
}
if (!array_key_exists("func", $params)) {
throw new WebException ("CallArgFunction", "no 'func' specified", -2);
}
$this->func = $params["func"];
unset($params['func']);
if (!is_callable(array($this, $this->func))) {
throw new WebException ("CallFunction", "'func' method not available", -3);
}
$rm = new \ReflectionMethod($this, $this->func);
$nbParams = count($params);
$nbArgsFix = $rm->getNumberOfRequiredParameters();
$nbArgs = $rm->getNumberOfParameters();
/* Check the number of arguments. */
if ($nbParams < $nbArgsFix) {
throw new WebException ("CallArgNumber", "you must provide at least " . $nbArgsFix . " arguments", 4);
}
if ($nbParams > $nbArgs) {
throw new WebException ("CallArgNumber", "you must provide at most " . $nbArgs . " arguments", 4);
}
$this->log("Calling '".$this->func."'");
$this->log("Params: ".print_r($params, true), 2);
return call_user_func_array(array($this, $this->func), $params);
}
private function Send(array $data)
{
static $status_messages = array(
200 => 'Ok',
400 => 'Bad request',
404 => 'Not Found',
403 => 'Not Authorized',
500 => 'Server Error',
);
header(sprintf('HTTP/1.0 %s %s', $this->status, $status_messages[$this->status]));
ob_clean();
flush();
$this->log("Data: ".print_r($data, true), 2);
echo json_encode($data);
}
}

43
Lib/db/AudioBook.php
View File

@@ -23,18 +23,18 @@ namespace BSR\Lib\db;
* @property string sql_collection
* @property string isbn
* @property string sql_isbn
* @property string readBy
* @property string sql_readBy
* @property string reader
* @property string sql_reader
* @property string cover
* @property string sql_cover
* @property string category
* @property string sql_category
* @property string date
* @property string sql_date
* @property string code3
* @property string sql_code3
* @property string code3Long
* @property string sql_code3Long
* @property string availabilityDate
* @property string sql_availabilityDate
* @property string producerCode
* @property string sql_producerCode
* @property string producer
* @property string sql_producer
* @property string genre
* @property string sql_genre
* @property string genreCode
@@ -45,12 +45,12 @@ namespace BSR\Lib\db;
* @property string sql_link
* @property string linkTitle
* @property string sql_linkTitle
* @property string typeMedia1
* @property string sql_typeMedia1
* @property string mediaType
* @property string sql_mediaType
*/
class AudioBook extends DbMapping
{
protected $attributeNames = 'id title author code summary editor media collection isbn readBy reader cover category date code3 code3Long genre genreCode coverdisplay link linkTitle mediaType typeMedia1';
protected $attributeNames = 'id title author code summary editor media collection isbn reader cover category availabilityDate producerCode producer genre genreCode coverdisplay link linkTitle mediaType';
public static function find($id) {
return self::findBy('NoticeID', $id);
@@ -88,22 +88,20 @@ class AudioBook extends DbMapping
Fields.[490a] AS collection,
isbn.DisplayText AS isbn,
Fields.[901] AS reader,
Fields.[901] AS readBy, -- for compatibility
Fields.[899a] AS cover,
'' AS category, -- supposed to come from tags 600, 610, 650, 651, 655, 690, 691, 695, 696 but always empty anyway
CONVERT(VARCHAR, Notices.[CreationDate], 102) AS date,
LTRIM(RTRIM(Notices.[userdefined3code])) AS code3,
[Code3].TextFre AS code3Long,
[GenreCode].TextFre AS genre,
[GenreCode].Code AS genreCode,
item1.AcquisitionDate AS availabilityDate,
ProducerCode.TextFre As producer,
LTRIM(RTRIM(ProducerCode.Code)) AS producerCode,
GenreCode.TextFre As genre,
LTRIM(RTRIM(GenreCode.Code)) AS genreCode,
Notices.[coverdisplay],
Fields.[856u] AS link,
Fields.[856z] AS linkTitle,
Notices.[MediaType1Code] AS mediaType,
Notices.[MediaType1Code] AS typeMedia1 -- for compatibility
FROM Notices
INNER JOIN Codes AS Code3 ON Notices.userdefined3code = Code3.Code AND Code3.Type=6
INNER JOIN Codes AS GenreCode ON MediaType2Code = GenreCode.Code AND GenreCode.Type = 2
INNER JOIN Codes As GenreCode ON Notices.MediaType2Code = GenreCode.Code AND GenreCode.Type = 2
INNER JOIN Codes AS ProducerCode ON Notices.userdefined3code = ProducerCode.Code AND ProducerCode.Type=6
LEFT OUTER JOIN (
SELECT *
FROM (
@@ -137,6 +135,11 @@ class AudioBook extends DbMapping
FOR Field IN ([520], [901], [300], [020], [490a], [260b], [260c], [856u], [856z], [899a])
) AS pvt
) Fields ON Notices.NoticeID = Fields.NoticeID
OUTER APPLY (
SELECT TOP 1 *
FROM Items
WHERE Notices.NoticeID = NoticeId
) AS item1
LEFT JOIN Authorities AS isbn ON isbn.AuthorityID = Fields.[020]
WHERE
LTRIM(RTRIM(Notices.[%s])) IN ('%s')

1064
NetBiblio.php
View File

File diff suppressed because it is too large Load Diff

8
README.md
View File

@@ -1,5 +1,5 @@
# README #
This repository contains the code for the WebService used internally at the [BSR](http://bibliothequesonore.ch/) by the Drupal website and both the iOS and Android applications.
# README #
This repository contains the code for the WebService used internally at the [BSR](http://bibliothequesonore.ch/) by the Drupal website and both the iOS and Android applications.
For more information, please consult the internal documentation : http://192.168.1.250/dokuwiki/doku.php?id=webservice

40
index.php
View File

@@ -1,20 +1,20 @@
<?php
namespace BSR;
ini_set('display_errors', 'On');
// register an autoloader to automatically load classes
// the namespace for the class must begin with BSR and
// otherwise respect the PSR-4 standard
spl_autoload_register(function ($class) {
$class = substr($class, strlen('BSR'));
$path = sprintf('%s/%s.php', __DIR__, str_replace('\\', '/', $class));
if (file_exists($path)) {
require $path;
}
});
$web = new NetBiblio();
$web->Run();
<?php
namespace BSR;
ini_set('display_errors', 'On');
// register an autoloader to automatically load classes
// the namespace for the class must begin with BSR and
// otherwise respect the PSR-4 standard
spl_autoload_register(function ($class) {
$class = substr($class, strlen('BSR'));
$path = sprintf('%s/%s.php', __DIR__, str_replace('\\', '/', $class));
if (file_exists($path)) {
require $path;
}
});
$web = new NetBiblio();
$web->Run();

6
mobile.php
View File

@@ -1,4 +1,4 @@
<?php
// this file is here for compatibility purpose, do not delete
<?php
// this file is here for compatibility purpose, do not delete
require_once('index.php');