require (JIRAFEAU_ROOT . 'lib/template/footer.php');
exit;
}
- echo '<div class="info">';
- echo '<h2>' . t('Welcome to Jirafeau\'s query interface') . '</h2>';
- echo '<p>';
- echo t('This interface permits to script your uploads and downloads.') .
- ' ' . t('The instructions above show how to query this interface.');
- echo '</p>';
-
- echo '<h3>' . t('Get Jirafeau\'s version') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>get_version=</b>1<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('First line is the version number.') . '<br /></p>';
- echo '<p>';
- echo t('Example') . ": <a href=\"" . $web_root . "script.php?get_version=1\">" . $web_root . "script.php?get_version=1</a> ";
- echo '</p>';
-
- echo '<h3>' . t('Get server capacity') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>get_capacity=</b>1<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('First line is the server capacity (in Bytes).') . '<br /></p>';
- echo '<p>';
- echo t('Example') . ": <a href=\"" . $web_root . "script.php?get_capacity=1\">" . $web_root . "script.php?get_capacity=1</a> ";
- echo '</p>';
-
- echo '<h3>' . t('Maximal allowed size of an uploaded file') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>get_maximal_upload_size=</b>1<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('First line returns size (in MB).') . '<br /></p>';
- echo '<p>';
- echo t('Example') . ": <a href=\"" . $web_root . "script.php?get_maximal_upload_size=1\">" . $web_root . "script.php?get_maximal_upload_size=1</a> ";
- echo '</p>';
-
- echo '<h3>' . t('Upload a file') . ':</h3>';
- echo '<p>';
- echo t('Send a POST query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>file=</b>C:\\your\\file\\path<i> (" . t('Required') . ")</i> <br />";
- echo "<b>time=</b>[minute|hour|day|week|month|year|none]<i> (" . t('Optional') . ', '. t('default: none') . ")</i> <br />";
- echo "<b>password=</b>your_password<i> (" . t('Optional') . ")</i> <br />";
- echo "<b>one_time_download=</b>1<i> (" . t('Optional') . ")</i> <br />";
- echo "<b>upload_password=</b>your_upload_password<i> (" . t('Optional') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('First line is the download reference and the second line the delete code.') . '<br /></p>';
-
- echo '<h3>' . t('Get a file') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>h=</b>your_download_reference<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>';
- echo t('If a password has been set, send a POST request with it.');
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>password=</b>your_password<i> (" . t('Optional') . ")</i> <br />";
- echo '</p>';
- echo '<p>';
- echo t('Example') . ": <a href=\"" . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU\">" . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU</a> ";
- echo '</p>';
-
- echo '<h3>' . t('Delete a file') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>h=</b>your_download_reference<i> (" . t('Required') . ")</i> <br />";
- echo "<b>d=</b>yout_delete_code<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return "Ok" if succeeded, "Error" otherwhise.') . '<br /></p>';
- echo '<p>';
- echo t('Example') . ": <a href=\"" . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU&d=0d210a952\">" . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU&d=0d210a952</a> ";
- echo '</p>';
-
- echo '<h3>' . t('Get a generated script') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>lang=</b>[";
- foreach ($script_langages as $lang => $name)
- echo $lang;
- echo "]<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content of the code.') . '<br /></p>';
- echo '<p>';
- echo t('Example') . ": <br />";
- foreach ($script_langages as $lang => $name)
- echo "$name: <a href=\"" . $web_root . "script.php?lang=$lang\">" . $web_root . "script.php?lang=$lang</a> ";
- echo '</p>';
-
- echo '<h3>' . t('Initalize an asynchronous transfer') . ':</h3>';
- echo '<p>';
- echo t('The goal is to permit to transfer big file, chunk by chunk.') . ' ';
- echo t('Chunks of data must be sent in order.');
- echo '</p>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php?init_async</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>filename=</b>file_name.ext<i> (" . t('Required') . ")</i> <br />";
- echo "<b>type=</b>MIME_TYPE<i> (" . t('Optional') . ")</i> <br />";
- echo "<b>time=</b>[minute|hour|day|week|month|year|none]<i> (" . t('Optional') . ', '. t('default: none') . ")</i> <br />";
- echo "<b>password=</b>your_password<i> (" . t('Optional') . ")</i> <br />";
- echo "<b>one_time_download=</b>1<i> (" . t('Optional') . ")</i> <br />";
- echo "<b>upload_password=</b>your_upload_password<i> (" . t('Optional') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('First line is the asynchronous transfer reference and the second line the code to use in the next operation.') . '<br /></p>';
-
- echo '<h3>' . t('Push data during asynchronous transfer') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php?push_async</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>ref=</b>async_reference<i> (" . t('Required') . ")</i> <br />";
- echo "<b>data=</b>data_chunk<i> (" . t('Required') . ")</i> <br />";
- echo "<b>code=</b>last_provided_code<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('Returns the next code to use.') . '<br /></p>';
-
- echo '<h3>' . t('Finalize asynchronous transfer') . ':</h3>';
- echo '<p>';
- echo t('Send a GET query to') . ': <i>' . $web_root . 'script.php?end_async</i><br />';
- echo '<br />';
- echo t('Parameters') . ':<br />';
- echo "<b>ref=</b>async_reference<i> (" . t('Required') . ")</i> <br />";
- echo "<b>code=</b>last_provided_code<i> (" . t('Required') . ")</i> <br />";
- echo '</p>';
- echo '<p>' . t('This will return brut text content.') . ' ' .
- t('First line is the download reference and the second line the delete code.') . '<br /></p>';
-
- echo '</div><br />';
+ ?>
+ <div class="info">
+ <h2>Scriting interface</h2>
+ <p>This interface permits to script your uploads and downloads.</p>
+ <p>See <a href="https://gitlab.com/mojo42/Jirafeau/blob/master/script.php">source code</a> of this interface to understand availablee calls :)</p>
+ </div>
+ <br />
+ <?php
require (JIRAFEAU_ROOT . 'lib/template/footer.php');
exit;
}
git.p6c8.net / jirafeau_project.git / blobdiff