From: Jerome Jutteau Date: Wed, 20 Feb 2013 12:17:22 +0000 (+0000) Subject: New data block feature X-Git-Tag: 1.1~210 X-Git-Url: https://git.p6c8.net/jirafeau_project.git/commitdiff_plain/8adcdf2e61aa2746235d99202ad07b59d0198b04 New data block feature --- diff --git a/admin.php b/admin.php index 2fd8d29..5867961 100755 --- a/admin.php +++ b/admin.php @@ -145,6 +145,26 @@ require (JIRAFEAU_ROOT . 'lib/template/header.php'); + +
+ + + + + + + + + + +
+ +
@@ -226,6 +246,14 @@ if (isset ($_POST['action'])) echo t('Number of cleaned files') . ' : ' . $total; echo '

'; } + elseif (strcmp ($_POST['action'], 'clean_block') == 0) + { + $total = jirafeau_admin_clean_block (); + echo '
' . NL; + echo '

'; + echo t('Number of cleaned files') . ' : ' . $total; + echo '

'; + } elseif (strcmp ($_POST['action'], 'list') == 0) { jirafeau_admin_list ("", "", ""); diff --git a/install.php b/install.php index c753c5b..26ae291 100755 --- a/install.php +++ b/install.php @@ -95,7 +95,7 @@ jirafeau_check_var_dir ($path) $path . '
' . $solution_str . '
' . $mkdir_str2); - foreach (array ('files', 'links', 'async') as $subdir) + foreach (array ('files', 'links', 'async', 'block') as $subdir) { $subpath = $path.$subdir; diff --git a/lib/config.php b/lib/config.php index 31fbded..e80eefc 100644 --- a/lib/config.php +++ b/lib/config.php @@ -43,6 +43,10 @@ $cfg['preview'] = true; * true: Will show a download page (with preview if permited and possible). * false: Will directly download file or preview (if permited and possible). */ $cfg['download_page'] = false; +/* Block feature: + The scripting interface can propose to create, read, write, delete blocks + of data. */ +$cfg['enable_blocks'] = false; if ((basename (__FILE__) != 'config.local.php') && file_exists (JIRAFEAU_ROOT.'lib/config.local.php')) diff --git a/lib/functions.php b/lib/functions.php index 87d2cff..223fd8e 100755 --- a/lib/functions.php +++ b/lib/functions.php @@ -60,8 +60,8 @@ base_16_to_64 ($num) $i = 0; # Convert long hex string to bin. $size = strlen ($num); - for ($i = 0; $i < $size; $i++) - $b .= $hex2bin{hexdec ($num{$i})}; + + $b .= $hex2bin{hexdec ($num{$i})}; # Convert long bin to base 64. $size *= 4; for ($i = $size - 6; $i >= 0; $i -= 6) @@ -499,7 +499,10 @@ function check_errors () if (!is_writable (VAR_ASYNC)) add_error (t('The async directory is not writable!'), VAR_ASYNC); - /* Check if the install.php script is still in the directory. */ + if (!is_writable (VAR_BLOCK)) + add_error (t('The block directory is not writable!'), VAR_BLOCK); + + /* Check if the install.php script is still in the directory. */ if (file_exists (JIRAFEAU_ROOT . 'install.php')) add_error (t('Installer script still present'), t('Please make sure to delete the installer script ' . @@ -920,4 +923,309 @@ jirafeau_async_end ($ref, $code) jirafeau_async_delete ($ref); return $md5_link . NL . $delete_link_code; } + +/** + * Delete a block. + * @param $id identifier of the block. + */ +function +jirafeau_block_delete_ ($id) +{ + $p = VAR_BLOCK . s2p ($id); + if (!file_exists ($p)) + return; + + if (file_exists ($p . $id)) + unlink ($p . $id); + if (file_exists ($p . $id . '_infos')) + unlink ($p . $id . '_infos'); + $parse = $p; + $scan = array(); + while (file_exists ($parse) + && ($scan = scandir ($parse)) + && count ($scan) == 2 // '.' and '..' folders => empty. + && basename ($parse) != basename (VAR_BLOCK)) + { + rmdir ($parse); + $parse = substr ($parse, 0, strlen($parse) - strlen(basename ($parse)) - 1); + } +} + +/** + * Create a file filled with zeros. + * @param $size size of the file. + * @return a string corresponding to an id or the string "Error" + */ +function +jirafeau_block_init ($size) +{ + if (!ctype_digit ($size) || $size <= 0) + return "Error"; + + /* Create folder. */ + $id; + do + { + $id = jirafeau_gen_random (32); + $p = VAR_BLOCK . s2p ($id); + } while (file_exists ($p)); + @mkdir ($p, 0755, true); + if (!file_exists ($p)) + { + echo "Error"; + return; + } + + /* Create block. */ + $p .= $id; + $h = fopen ($p, 'w'); + $fill = str_repeat ("\0", 1024); + for ($cnt = 0; $cnt < $size; $cnt += 1024) + { + if ($size - $cnt < 1024) + $fill = str_repeat ("\0", $size - $cnt); + if (fwrite ($h, $fill) === false) + { + fclose ($h); + jirafeau_block_delete_ ($id); + return "Error"; + } + } + fclose ($h); + + /* Generate a write/delete code. */ + $code = jirafeau_gen_random (12); + + /* Add block infos. */ + if (file_put_contents ($p . '_infos', date ('U') . NL . $size . NL . $code) === FALSE) + { + jirafeau_block_delete_ ($id); + return "Error"; + } + + return $id . NL . $code; +} + +/** + * Read some data in a block. + * @param $id identifier of the block + * @param $start where to read data (starting from zero). + * @param $length length to read. + * @return echo data + */ +function +jirafeau_block_read ($id, $start, $length) +{ + if (!ctype_digit ($start) || $start < 0 + || !ctype_digit ($length) || $length <= 0) + { + echo "Error"; + return; + } + + $p = VAR_BLOCK . s2p ($id) . $id; + if (!file_exists ($p)) + { + echo "Error"; + return; + } + + /* Check date. */ + $f = file ($p . '_infos'); + $date = trim ($f[0]); + $block_size = trim ($f[1]); + $stored_code = trim ($f[2]); + /* Update date. */ + if (date ('U') - $date > JIRAFEAU_HOUR + && date ('U') - $date < JIRAFEAU_MONTH) + { + if (file_put_contents ($p . '_infos', date ('U') . NL . $block_size . NL . $stored_code) === FALSE) + { + jirafeau_block_delete_ ($id); + echo "Error"; + return; + } + } + /* Remove data. */ + elseif (date ('U') - $date >= JIRAFEAU_MONTH) + { + echo date ('U'). " $date "; + jirafeau_block_delete_ ($id); + echo "Error"; + return; + } + + if ($start + $length > $block_size) + { + echo "Error"; + return; + } + + /* Read content. */ + header ('Content-Length: ' . $length); + header ('Content-Disposition: attachment'); + + $r = fopen ($p, 'r'); + if (fseek ($r, $start) != 0) + { + echo "Error"; + return; + } + $c = 1024; + for ($cnt = 0; $cnt < $length && !feof ($r); $cnt += 1024) + { + if ($length - $cnt < 1024) + $c = $length - $cnt; + print fread ($r, $c); + ob_flush(); + } + fclose ($r); +} + +/** + * Write some data in a block. + * @param $id identifier of the block + * @param $start where to writing data (starting from zero). + * @param $data data to write. + * @param $code code to allow writing. + * @return string "Ok" or string "Error". + */ +function +jirafeau_block_write ($id, $start, $data, $code) +{ + if (!ctype_digit ($start) || $start < 0 + || strlen ($code) == 0) + return "Error"; + + $p = VAR_BLOCK . s2p ($id) . $id; + if (!file_exists ($p)) + return "Error"; + + /* Check date. */ + $f = file ($p . '_infos'); + $date = trim ($f[0]); + $block_size = trim ($f[1]); + $stored_code = trim ($f[2]); + /* Update date. */ + if (date ('U') - $date > JIRAFEAU_HOUR + && date ('U') - $date < JIRAFEAU_MONTH) + { + if (file_put_contents ($p . '_infos', date ('U') . NL . $block_size . NL . $stored_code) === FALSE) + { + jirafeau_block_delete_ ($id); + return "Error"; + } + } + /* Remove data. */ + elseif (date ('U') - $date >= JIRAFEAU_MONTH) + { + jirafeau_block_delete_ ($id); + return "Error"; + } + + /* Check code. */ + if ($stored_code != $code) + { + echo "Error"; + return; + } + + /* Check data. */ + $size = $data['size']; + if ($size <= 0) + return "Error"; + if ($start + $size > $block_size) + return "Error"; + + /* Open data. */ + $r = fopen ($data['tmp_name'], 'r'); + + /* Open Block. */ + $w = fopen ($p, 'r+'); + if (fseek ($w, $start) != 0) + return "Error"; + + /* Write content. */ + $c = 1024; + for ($cnt = 0; $cnt <= $size && !feof ($w); $cnt += 1024) + { + if ($size - $cnt < 1024) + $c = $size - $cnt; + $d = fread ($r, $c); + fwrite ($w, $d); + } + fclose ($r); + fclose ($w); + unlink ($data['tmp_name']); + return "Ok"; +} + +/** + * Delete a block. + * @param $id identifier of the block. + * @param $code code to allow writing. + * @return string "Ok" or string "Error". + */ +function +jirafeau_block_delete ($id, $code) +{ + $p = VAR_BLOCK . s2p ($id) . $id; + + if (!file_exists ($p)) + return "Error"; + + $f = file ($p . '_infos'); + $date = trim ($f[0]); + $block_size = trim ($f[1]); + $stored_code = trim ($f[2]); + + if ($code != $stored_code) + return "Error"; + + jirafeau_block_delete_ ($id); + return "Ok"; +} + +/** + * Clean old unused blocks. + * @return number of cleaned blocks. + */ +function +jirafeau_admin_clean_block () +{ + $count = 0; + /* Get all blocks. */ + $stack = array (VAR_BLOCK); + while (($d = array_shift ($stack)) && $d != NULL) + { + $dir = scandir ($d); + + foreach ($dir as $node) + { + if (strcmp ($node, '.') == 0 || strcmp ($node, '..') == 0) + continue; + + if (is_dir ($d . $node)) + { + /* Push new found directory. */ + $stack[] = $d . $node . '/'; + } + elseif (is_file ($d . $node) && preg_match ('/\_infos/i', "$node")) + { + /* Read block informations. */ + $f = file ($d . $node); + $date = trim ($f[0]); + $block_size = trim ($f[1]); + if (date ('U') - $date >= JIRAFEAU_MONTH) + { + jirafeau_block_delete_ (substr($node, 0, -6)); + $count++; + } + } + } + } + return $count; +} + + ?> diff --git a/lib/lang/fr.php b/lib/lang/fr.php index 00d31f1..8e20a4b 100755 --- a/lib/lang/fr.php +++ b/lib/lang/fr.php @@ -77,6 +77,7 @@ $tr = array ( 'step' => 'étape', 'out of' => 'sur', 'Administration password' => 'Mot de passe d\'administration', + 'Clean unused blocks' => 'Nettoie les bloques inutilisés', 'Finalisation' => 'Finalisation', 'Jirafeau is setting the website according to the configuration you provided.' => 'Jirafeau se configure selon les paramêtres donnés', 'Previous step' => 'Etape précedente', @@ -137,6 +138,8 @@ $tr = array ( 'Get Jirafeau\'s version' => 'Récupérer la version de Jirafeau', 'Send a GET query to' => 'Envoyez une requette GET à', 'Send a POST query to' => 'Envoyez une requette POST à', + 'Upload a file' => 'Envoyer un fichier', + 'Get a file' => 'Récupérer un ficher', 'Required' => 'Requis', 'Optional' => 'Optionel', 'Parameters' => 'Paramètres', @@ -156,6 +159,16 @@ $tr = array ( => 'La première ligne correspond à la référence de transfert asynchrone, la seconde au code à utiliser dans la prochaine requette.', 'Push data during asynchronous transfert' => 'Envoyer des données pendant un transfert asynchrone', 'Returns the next code to use.' => 'Renvoie le prochain code à utiliser.', - 'Finalize asynchronous transfert' => 'Finalise un transfert asynchrone', + 'Finalize asynchronous transfert' => 'Finaliser un transfert asynchrone', + 'Create a data block' => 'Creer un bloque de données', + 'This interface permits to create a block of data filled with zeros.' => 'Cette interface permet de creer un bloque de données remplies de zeros.', + 'You can read selected parts, write (using a code) and delete the block.' => 'Vous pouvez lire, écrire (en utilisant un code) et supprimer le bloque.', + 'Blocks may be removed after a month of non usage.' => 'Les bloques non utilisés depuis plus d\'un mois seront probablement supprimés.', + 'Read data in a block' => 'Lire des données dans un bloque', + 'Write data in a block' => 'Ecrire des données dans un bloque', + 'First line is a block id the second line the edit/delete code.' => 'La premiere ligne est l\'identifiant du bloque, la seconde est son code d\'écriture/suppression.', + 'This will return asked data or "Error" string.' => 'Retourne les données ou la chaine "Error".', + 'Delete a block' => 'Supprimer un bloque', + 'This will return "Ok" or "Error" string.' => 'Retourn la chaine "Ok" ou "Error".', ); - ?> \ No newline at end of file + ?> diff --git a/lib/settings.php b/lib/settings.php index 74bf771..133113d 100644 --- a/lib/settings.php +++ b/lib/settings.php @@ -24,6 +24,7 @@ define ('JIRAFEAU_VERSION', '1.0'); define ('VAR_FILES', $cfg['var_root'] . 'files/'); define ('VAR_LINKS', $cfg['var_root'] . 'links/'); define ('VAR_ASYNC', $cfg['var_root'] . 'async/'); +define ('VAR_BLOCK', $cfg['var_root'] . 'block/'); /* Useful constants. */ if (!defined ('NL')) diff --git a/script.php b/script.php index 25548e6..45ca635 100755 --- a/script.php +++ b/script.php @@ -182,6 +182,57 @@ if ($_SERVER['REQUEST_METHOD'] == "GET" && count ($_GET) == 0) echo '

' . t('This will return brut text content.') . ' ' . t('First line is the download reference and the second line the delete code.') . '

'; + if ($cfg['enable_blocks']) + { + echo '

' . t('Create a data block') . ':

'; + echo '

'; + echo t('This interface permits to create a block of data filled with zeros.') . + ' ' . t('You can read selected parts, write (using a code) and delete the block.') . + ' ' . t('Blocks may be removed after a month of non usage.'); + echo '

'; + echo '

'; + echo t('Send a GET query to') . ': ' . $web_root . 'script.php?init_block
'; + echo '
'; + echo t('Parameters') . ':
'; + echo "size=size_in_bytes (" . t('Required') . ")
"; + echo '

'; + echo '

' . t('This will return brut text content.') . ' ' . + t('First line is a block id the second line the edit/delete code.') . '

'; + + echo '

' . t('Read data in a block') . ':

'; + echo '

'; + echo t('Send a GET query to') . ': ' . $web_root . 'script.php?read_block
'; + echo '
'; + echo t('Parameters') . ':
'; + echo "id=block_id (" . t('Required') . ")
"; + echo "start=byte_position_starting_from_zero (" . t('Required') . ")
"; + echo "length=length_to_read_in_bytes (" . t('Required') . ")
"; + echo '

'; + echo '

' . t('This will return asked data or "Error" string.') . '

'; + + echo '

' . t('Write data in a block') . ':

'; + echo '

'; + echo t('Send a GET query to') . ': ' . $web_root . 'script.php?write_block
'; + echo '
'; + echo t('Parameters') . ':
'; + echo "id=block_id (" . t('Required') . ")
"; + echo "code=block_code (" . t('Required') . ")
"; + echo "start=byte_position_starting_from_zero (" . t('Required') . ")
"; + echo "data=data_to_write (" . t('Required') . ")
"; + echo '

'; + echo '

' . t('This will return "Ok" or "Error" string.') . '

'; + + echo '

' . t('Delete a block') . ':

'; + echo '

'; + echo t('Send a GET query to') . ': ' . $web_root . 'script.php?delete_block
'; + echo '
'; + echo t('Parameters') . ':
'; + echo "id=block_id (" . t('Required') . ")
"; + echo "code=block_code (" . t('Required') . ")
"; + echo '

'; + echo '

' . t('This will return "Ok" or "Error" string.') . '

'; + } + echo '
'; require (JIRAFEAU_ROOT . 'lib/template/footer.php'); exit; @@ -515,6 +566,44 @@ elseif (isset ($_GET['end_async'])) else echo jirafeau_async_end ($_POST['ref'], $_POST['code']); } +/* Initialize block. */ +elseif (isset ($_GET['init_block']) && $cfg['enable_blocks']) +{ + if (!isset ($_POST['size'])) + echo "Error"; + else + echo jirafeau_block_init ($_POST['size']); +} +/* Read data in block. */ +elseif (isset ($_GET['read_block']) && $cfg['enable_blocks']) +{ + if (!isset ($_POST['id']) + || !isset ($_POST['start']) + || !isset ($_POST['length'])) + echo "Error"; + else + jirafeau_block_read ($_POST['id'], $_POST['start'], $_POST['length']); +} +/* Write data in block. */ +elseif (isset ($_GET['write_block']) && $cfg['enable_blocks']) +{ + if (!isset ($_POST['id']) + || !isset ($_POST['start']) + || !isset ($_FILES['data']) + || !isset ($_POST['code'])) + echo "Error"; + else + echo jirafeau_block_write ($_POST['id'], $_POST['start'], $_FILES['data'], $_POST['code']); +} +/* Delete block. */ +elseif (isset ($_GET['delete_block']) && $cfg['enable_blocks']) +{ + if (!isset ($_POST['id']) + || !isset ($_POST['code'])) + echo "Error"; + else + echo jirafeau_block_delete ($_POST['id'], $_POST['code']); +} else echo "Error"; exit;