lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change signature of file to match other urls to link/download files.

Browse Source
This commit is contained in:
Laurent Destailleur 2017-10-05 10:21:52 +02:00
parent 1cacfe4935
commit f0b314dfd7
2 changed files with 75 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
htdocs/api/class/api_documents.class.php
View File

@ -23,7 +23,6 @@ use Luracast\Restler\Format\UploadFormat;
require_once DOL_DOCUMENT_ROOT.'/main.inc.php'; require_once DOL_DOCUMENT_ROOT.'/main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
/** /**
* API class for receive files * API class for receive files
@ -50,13 +49,15 @@ class Documents extends DolibarrApi
$this->db = $db; $this->db = $db;
} }
/** /**
* Returns a document. * Returns a document. Note that, this API is similar to using the wrapper link "documents.php" to download
* a file (used for internal HTML links of documents into application), but with no need to be into a logged session (no need to post the session cookie).
* *
* @param string $module_part Name of module or area concerned by file download ('facture', ...) * @param string $module_part Name of module or area concerned by file download ('facture', ...)
* @param string $ref Reference of object (This will define subdir automatically) * @param string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf)
* @param string $subdir NOT YET AVAILABLE : Subdirectory (Only if ref not provided) * @param int $regeneratedoc If requested document is the main document of an object, setting this to 1 ask API to regenerate document before returning it (supported for some module_part only). It is no effect in other cases.
* Also, note that setting this to 1 nead write access on object.
* @return array List of documents * @return array List of documents
* *
* @throws 500 * @throws 500
@ -65,70 +66,68 @@ class Documents extends DolibarrApi
* @throws 401 * @throws 401
* @throws 200 * @throws 200
*/ */
public function index($module_part, $ref='', $subdir='') { public function index($module_part, $original_file='', $regeneratedoc=0)
global $conf; {
$this->invoice = new Facture($this->db); global $conf;
if (empty($module_part)) { if (empty($module_part)) {
throw new RestException(400, 'bad value for parameter modulepart'); throw new RestException(400, 'bad value for parameter modulepart');
} }
if (empty($ref) && empty($subdir)) { if (empty($original_file)) {
throw new RestException(400, 'bad value for parameter ref or subdir'); throw new RestException(400, 'bad value for parameter ref or subdir');
} }
if (empty($ref)) {
throw new RestException(501, 'FeatureNotYetAvailable'); //--- Finds and returns the document
} $entity=$conf->entity;
if (!DolibarrApiAccess::$user->rights->ecm->read) {
throw new RestException(401); $check_access = dol_check_secure_access_document($module_part, $original_file, $entity, DolibarrApiAccess::$user, '', ($regeneratedoc ? 'write' : 'read'));
} $accessallowed = $check_access['accessallowed'];
$sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
//--- Generates the document $original_file = $check_access['original_file'];
$hidedetails = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS) ? 0 : 1;
$hidedesc = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DESC) ? 0 : 1; if (preg_match('/\.\./',$original_file) || preg_match('/[<>|]/',$original_file))
$hideref = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_REF) ? 0 : 1; {
$result = $this->invoice->fetch(0, $ref); throw new RestException(401);
if( ! $result ) { }
throw new RestException(404, 'Invoice not found'); if (!$accessallowed) {
} throw new RestException(401);
$result = $this->invoice->generateDocument($this->invoice->modelpdf, $outputlangs, $hidedetails, $hidedesc, $hideref); }
if( $result <= 0 ) {
throw new RestException(500, 'Error generating document'); // --- Generates the document
if ($regeneratedoc)
{
$hidedetails = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS) ? 0 : 1;
$hidedesc = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_DESC) ? 0 : 1;
$hideref = empty($conf->global->MAIN_GENERATE_DOCUMENTS_HIDE_REF) ? 0 : 1;
if ($module_part == 'facture' || $module_part == 'invoice')
{
require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
$this->invoice = new Facture($this->db);
$result = $this->invoice->fetch(0, $ref);
if( ! $result ) {
throw new RestException(404, 'Invoice not found');
}
$result = $this->invoice->generateDocument($this->invoice->modelpdf, $outputlangs, $hidedetails, $hidedesc, $hideref);
if( $result <= 0 ) {
throw new RestException(500, 'Error generating document');
}
}
} }
$filename = basename($original_file);
$original_file_osencoded=dol_osencode($original_file); // New file name encoded in OS encoding charset
if (! file_exists($original_file_osencoded))
{
throw new RestException(404, 'File not found');
}
//--- Finds and returns the document $file_content=file_get_contents($original_file_osencoded);
$original_file = str_replace("../","/", $ref.'/'.$ref.'.pdf');
$refname=basename(dirname($original_file)."/");
$entity=$conf->entity;
$check_access = dol_check_secure_access_document($module_part,$original_file,$entity,DolibarrApiAccess::$user);
$accessallowed = $check_access['accessallowed'];
$sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
$original_file = $check_access['original_file'];
if (preg_match('/\.\./',$original_file) || preg_match('/[<>|]/',$original_file))
{
throw new RestException(401);
}
if (!$accessallowed) {
throw new RestException(401);
}
$filename = basename($original_file);
$original_file_osencoded=dol_osencode($original_file); // New file name encoded in OS encoding charset
if (! file_exists($original_file_osencoded))
{
throw new RestException(404, 'File not found');
}
$file_content=file_get_contents($original_file_osencoded);
return array('filename'=>$filename, 'content'=>base64_encode($file_content), 'encoding'=>'MIME base64 (base64_encode php function, http://php.net/manual/en/function.base64-encode.php)' ); return array('filename'=>$filename, 'content'=>base64_encode($file_content), 'encoding'=>'MIME base64 (base64_encode php function, http://php.net/manual/en/function.base64-encode.php)' );
} }
/** /**
* Return a document. * Return a document.
* *
@ -141,10 +140,10 @@ class Documents extends DolibarrApi
public function get($id) { public function get($id) {
return array('note'=>'xxx'); return array('note'=>'xxx');
}*/ }*/
/** /**
* Push a file. * Push a file.
* Test sample 1: { "filename": "mynewfile.txt", "modulepart": "facture", "ref": "FA1701-001", "subdir": "", "filecontent": "content text", "fileencoding": "", "overwriteifexists": "0" }. * Test sample 1: { "filename": "mynewfile.txt", "modulepart": "facture", "ref": "FA1701-001", "subdir": "", "filecontent": "content text", "fileencoding": "", "overwriteifexists": "0" }.
* Test sample 2: { "filename": "mynewfile.txt", "modulepart": "medias", "ref": "", "subdir": "mysubdir1/mysubdir2", "filecontent": "content text", "fileencoding": "", "overwriteifexists": "0" }. * Test sample 2: { "filename": "mynewfile.txt", "modulepart": "medias", "ref": "", "subdir": "mysubdir1/mysubdir2", "filecontent": "content text", "fileencoding": "", "overwriteifexists": "0" }.
* *
@ -161,12 +160,12 @@ class Documents extends DolibarrApi
public function post($filename, $modulepart, $ref='', $subdir='', $filecontent='', $fileencoding='', $overwriteifexists=0) public function post($filename, $modulepart, $ref='', $subdir='', $filecontent='', $fileencoding='', $overwriteifexists=0)
{ {
global $db, $conf; global $db, $conf;
/*var_dump($modulepart); /*var_dump($modulepart);
var_dump($filename); var_dump($filename);
var_dump($filecontent); var_dump($filecontent);
exit;*/ exit;*/
require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php'; require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php';
if (!DolibarrApiAccess::$user->rights->ecm->upload) { if (!DolibarrApiAccess::$user->rights->ecm->upload) {
@ -190,7 +189,7 @@ class Documents extends DolibarrApi
$object=new Facture($db); $object=new Facture($db);
$result = $object->fetch('', $ref); $result = $object->fetch('', $ref);
} }
if (! ($object->id > 0)) if (! ($object->id > 0))
{ {
throw new RestException(500, 'The object '.$modulepart." with ref '".$ref."' was not found."); throw new RestException(500, 'The object '.$modulepart." with ref '".$ref."' was not found.");
@ -198,7 +197,7 @@ class Documents extends DolibarrApi
$tmp = dol_check_secure_access_document($modulepart, $tmpreldir.$object->ref, $entity, DolibarrApiAccess::$user, $ref, 'write'); $tmp = dol_check_secure_access_document($modulepart, $tmpreldir.$object->ref, $entity, DolibarrApiAccess::$user, $ref, 'write');
$upload_dir = $tmp['original_file']; $upload_dir = $tmp['original_file'];
if (empty($upload_dir) || $upload_dir == '/') if (empty($upload_dir) || $upload_dir == '/')
{ {
throw new RestException(500, 'This value of modulepart does not support yet usage of ref. Check modulepart parameter or try to use subdir parameter instead of ref.'); throw new RestException(500, 'This value of modulepart does not support yet usage of ref. Check modulepart parameter or try to use subdir parameter instead of ref.');
@ -207,7 +206,7 @@ class Documents extends DolibarrApi
else else
{ {
if ($modulepart == 'invoice') $modulepart ='facture'; if ($modulepart == 'invoice') $modulepart ='facture';
$tmp = dol_check_secure_access_document($modulepart, $subdir, $entity, DolibarrApiAccess::$user, '', 'write'); $tmp = dol_check_secure_access_document($modulepart, $subdir, $entity, DolibarrApiAccess::$user, '', 'write');
$upload_dir = $tmp['original_file']; $upload_dir = $tmp['original_file'];
@ -216,14 +215,14 @@ class Documents extends DolibarrApi
throw new RestException(500, 'This value of modulepart does not support yet usage of ref. Check modulepart parameter or try to use subdir parameter instead of ref.'); throw new RestException(500, 'This value of modulepart does not support yet usage of ref. Check modulepart parameter or try to use subdir parameter instead of ref.');
} }
} }
$upload_dir = dol_sanitizePathName($upload_dir); $upload_dir = dol_sanitizePathName($upload_dir);
$destfile = $upload_dir . '/' . $original_file; $destfile = $upload_dir . '/' . $original_file;
$destfiletmp = DOL_DATA_ROOT.'/admin/temp/' . $original_file; $destfiletmp = DOL_DATA_ROOT.'/admin/temp/' . $original_file;
dol_delete_file($destfiletmp); dol_delete_file($destfiletmp);
if (!dol_is_dir($upload_dir)) { if (!dol_is_dir($upload_dir)) {
throw new RestException(401,'Directory not exists : '.$upload_dir); throw new RestException(401,'Directory not exists : '.$upload_dir);
} }
@ -232,7 +231,7 @@ class Documents extends DolibarrApi
{ {
throw new RestException(500, "File with name '".$original_file."' already exists."); throw new RestException(500, "File with name '".$original_file."' already exists.");
} }
$fhandle = @fopen($destfiletmp, 'w'); $fhandle = @fopen($destfiletmp, 'w');
if ($fhandle) if ($fhandle)
{ {
@ -244,9 +243,9 @@ class Documents extends DolibarrApi
{ {
throw new RestException(500, "Failed to open file '".$destfiletmp."' for write"); throw new RestException(500, "Failed to open file '".$destfiletmp."' for write");
} }
$result = dol_move($destfiletmp, $destfile, 0, $overwriteifexists, 1); $result = dol_move($destfiletmp, $destfile, 0, $overwriteifexists, 1);
return $result; return $result;
} }

1
htdocs/document.php
View File

@ -27,6 +27,7 @@
* \remarks Call of this wrapper is made with URL: * \remarks Call of this wrapper is made with URL:
* document.php?modulepart=repfichierconcerne&file=relativepathoffile * document.php?modulepart=repfichierconcerne&file=relativepathoffile
* document.php?modulepart=logs&file=dolibarr.log * document.php?modulepart=logs&file=dolibarr.log
* document.php?modulepart=logs&hashp=sharekey
*/ */
define('NOTOKENRENEWAL',1); // Disables token renewal define('NOTOKENRENEWAL',1); // Disables token renewal