remove scripting interface documentation

This will reduce translation work and avoid out of date documentation.
This first commit updates translation template.
Will still needt to remove translation from other files.

Signed-off-by: Jerome Jutteau <mojo@couak.net>

diff --git a/lib/locales/template.json b/lib/locales/template.json
index 5a90d57ad7adc7f2ed9cd6a8a5811672d778fedb..4c06bebd3f3e18bdf30f09e91e4c3bb1656cda50 100644 (file)
--- a/lib/locales/template.json
+++ b/lib/locales/template.json
@@ -105,37 +105,5 @@
     "Action": "",
     "Del link": "",
     "Del file and links": "",
-    "Deleted links": "",
-
-    "Welcome to Jirafeau's query interface": "",
-    "This interface permits to script your uploads and downloads.": "",
-    "The instructions above show how to query this interface.": "",
-    "Get server capacity": "",
-    "Maximal allowed size of an uploaded file": "",
-    "First line returns size (in MB).": "",
-    "Get Jirafeau's version": "",
-    "Send a GET query to": "",
-    "Send a POST query to": "",
-    "Upload a file": "",
-    "Get a file": "",
-    "Required": "",
-    "Optional": "",
-    "Parameters": "",
-    "This will return brut text content.": "",
-    "First line is the download reference and the second line the delete code.": "",
-    "First line is the server capacity (in Bytes).": "",
-    "Example": "",
-    "If a password has been set, send a POST request with it.": "",
-    "Delete a file": "",
-    "This will return \"Ok\" if succeeded, \"Error\" otherwhise.": "",
-    "Get a generated script": "",
-    "This will return brut text content of the code.": "",
-    "Initalize an asynchronous transfer": "",
-    "The goal is to permit to transfer big file, chunk by chunk.": "",
-    "Chunks of data must be sent in order.": "",
-    "First line is the asynchronous transfer reference and the second line the code to use in the next operation.": "",
-    "Push data during asynchronous transfer": "",
-    "Returns the next code to use.": "",
-    "Finalize asynchronous transfer": "",
-    "This will return \"Ok\" or \"Error\" string.": ""
+    "Deleted links": ""
 }

diff --git a/media/courgette/style.css.php b/media/courgette/style.css.php
index 5af7f58bbb656219c3df170ce8a0d047f97d2cf7..0e88ed5abf7a328b65ed168e5b5d0fb1e14b59ea 100644 (file)
--- a/media/courgette/style.css.php
+++ b/media/courgette/style.css.php
@@ -218,6 +218,7 @@ input[type="submit"]:focus {
 #upload_finished,
 #uploading,
 .message,
+.info,
 .error {
   text-align: center;
   color: #795548;

diff --git a/script.php b/script.php
index d17978cf15f5778196ecc8baf575f4f733893f60..8d6947b042815ed7e947b1d60d65b77ac5c2dba2 100644 (file)
--- a/script.php
+++ b/script.php
@@ -50,156 +50,14 @@ if ($_SERVER['REQUEST_METHOD'] == "GET" && count ($_GET) == 0)
         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&amp;d=0d210a952\">" . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU&amp;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;
 }