<?php

/**

* -------------------------------------------------------------------------

* Example plugin for GLPI

* -------------------------------------------------------------------------

*

* LICENSE

*

* This file is part of Example.

*

* Example is free software; you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation; either version 2 of the License, or

* (at your option) any later version.

*

* Example is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with Example. If not, see <http://www.gnu.org/licenses/>.

* -------------------------------------------------------------------------

* @copyright Copyright (C) 2006-2022 by Example plugin team.

* @license GPLv2 https://www.gnu.org/licenses/gpl-2.0.html

* @link https://github.com/pluginsGLPI/example

* -------------------------------------------------------------------------

*/

/**

* Show how to dowload a file (or any stream) from the REST API

* as well as metatadata stored in DB

*

* This itemtype is designed to be the same as Document in GLPI Core

* to focus on the file dowload and upload features

*

* Example to download a file with cURL

*

* $ curl -X GET \

* -H 'Content-Type: application/json' \

* -H 'Session-Token: s6f3jik227ttrsat7d8ap9laal' \

* -H 'Accept: application/octet-stream' \

* 'http://path/to/glpi/apirest.php/PluginExampleDocument/1' \

* --output /tmp/test_download

*

* Example to upload a file with cURL

*

* $ curl -X POST \

* -H 'Content-Type: multipart/form-data' \

* -H "Session-Token: s6f3jik227ttrsat7d8ap9laal" \

* -F 'uploadManifest={"input": {"name": "Uploaded document", "_filename" : ["file.txt"]}}' \

* -F 'file[]=@/tmp/test.txt' \

* 'http://path/to/glpi/apirest.php/PluginExampleDocument/'

*

*/

namespace GlpiPlugin\Example;

use Glpi\Exception\Http\NotFoundHttpException;

use Glpi\Exception\Http\HttpException;

use Document as GlpiDocument;

use function Safe\filemtime;

use function Safe\filesize;

use function Safe\fopen;

use function Safe\fread;

use function Safe\preg_match;

use function Safe\set_time_limit;

class Document extends GlpiDocument

{

/**

* Return the table used to store this object. Overloads the implementation in CommonDBTM

*

* @param string $classname Force class (to avoid late_binding on inheritance)

*

* @return string

**/

public static function getTable($classname = null)

{

if ($classname === null) {

$classname = static::class;

}

if ($classname == static::class) {

return parent::getTable(Document::class);

}

return parent::getTable($classname);

}

/**

* Prepare creation of an item

*

* @param array $input

* @return array|false

*/

public function prepareInputForAdd($input)

{

$input['_only_if_upload_succeed'] = true;

if (!isset($_FILES['file'])) {

return false;

}

// Move the uploaded file to GLPi's tmp dir

while (count($_FILES['file']['name']) > 0) {

$source = array_pop($_FILES['file']['name']);

$destination = GLPI_TMP_DIR . '/' . $source;

move_uploaded_file($source, $destination);

$input['_filename'][] = $source;

}

return parent::prepareInputForAdd($input);

}

/**

* Prepare update of an item

*

* @param array $input

* @return array|false

*/

public function prepareInputForUpdate($input)

{

// Do not allow update of document

return false;

}

/**

* Process required after loading an object from DB

* In this example, a file is sent as a byte strem then stops execution.

*

* @return void

*/

public function post_getFromDB()

{

// Check the user can view this itemtype and can view this item

if ($this->canView() && $this->canViewItem() && (isset($_SERVER['HTTP_ACCEPT']) && $_SERVER['HTTP_ACCEPT'] == 'application/octet-stream' || isset($_GET['alt']) && $_GET['alt'] == 'media')) {

$this->sendFile();

// and terminate script

}

}

/**

* Send a byte stream to the HTTP client and stops execution

*

* @return void

*/

protected function sendFile()

{

$streamSource = GLPI_DOC_DIR . '/' . $this->fields['filepath'];

// Ensure the file exists

if (!file_exists($streamSource) || !is_file($streamSource)) {

throw new NotFoundHttpException();

}

// Download range defaults to the full file

// get file metadata

$size = filesize($streamSource);

$begin = 0;

$end = $size - 1;

$mimeType = 'application/octet-stream';

$time = date('r', filemtime($streamSource));

// Open the file

$fileHandle = @fopen($streamSource, 'rb');

if (!$fileHandle) {

throw new HttpException(500, 'Internal Server Error');

}

// set range if specified by the client

if (isset($_SERVER['HTTP_RANGE']) && preg_match('/bytes=\h*(\d+)?-(\d*)[\D.*]?/i', $_SERVER['HTTP_RANGE'], $matches)) {

if (!empty($matches[1])) {

$begin = intval($matches[1]);

}

if (!empty($matches[2])) {

$end = min(intval($matches[2]), $end);

}

}

// seek to the begining of the range

$currentPosition = $begin;

if (fseek($fileHandle, $begin, SEEK_SET) < 0) {

throw new HttpException(500, 'Internal Server Error');

}

// send headers to ensure the client is able to detect a corrupted download

// example : less bytes than the expected range

// send meta data

// setup client's cache behavior

header('Expires: Mon, 26 Nov 1962 00:00:00 GMT');

header('Pragma: private'); /// IE BUG + SSL

header('Cache-control: private, must-revalidate'); /// IE BUG + SSL

header('Content-disposition: attachment; filename="' . $this->fields['filename'] . '"');

header("Content-type: $mimeType");

header("Last-Modified: $time");

header('Accept-Ranges: bytes');

header('Content-Length:' . ($end - $begin + 1));

header("Content-Range: bytes $begin-$end/$size");

header("Content-Transfer-Encoding: binary\n");

header('Connection: close');

// Prepare HTTP response

if ($begin > 0 || $end < $size - 1) {

header('HTTP/1.0 206 Partial Content');

} else {

header('HTTP/1.0 200 OK');

}

// Sends bytes until the end of the range or connection closed

while (!feof($fileHandle) && $currentPosition < $end && (connection_status() == 0)) {

// allow a few seconds to send a few KB.

set_time_limit(10);

$content = fread($fileHandle, min(1024 * 16, $end - $currentPosition + 1));

if (empty($content)) {

throw new HttpException(500, 'Internal Server Error');

} else {

print $content;

}

flush();

$currentPosition += 1024 * 16;

}

// End now to prevent any unwanted bytes

return;

}

}