From a7fb5680f650bbd23e7282b7f47e2b010112b1ed Mon Sep 17 00:00:00 2001 From: Jerome Jutteau Date: Tue, 7 Jul 2015 00:10:28 +0200 Subject: [PATCH] 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 --- lib/locales/template.json | 34 +------- media/courgette/style.css.php | 1 + script.php | 158 ++-------------------------------- 3 files changed, 10 insertions(+), 183 deletions(-) diff --git a/lib/locales/template.json b/lib/locales/template.json index 5a90d57..4c06beb 100644 --- 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 5af7f58..0e88ed5 100644 --- 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 d17978c..8d6947b 100644 --- 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 '
'; - echo '

' . t('Welcome to Jirafeau\'s query interface') . '

'; - echo '

'; - echo t('This interface permits to script your uploads and downloads.') . - ' ' . t('The instructions above show how to query this interface.'); - echo '

'; - - echo '

' . t('Get Jirafeau\'s version') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "get_version=1 (" . t('Required') . ")
"; - echo '

'; - echo '

' . t('This will return brut text content.') . ' ' . - t('First line is the version number.') . '

'; - echo '

'; - echo t('Example') . ": " . $web_root . "script.php?get_version=1 "; - echo '

'; - - echo '

' . t('Get server capacity') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "get_capacity=1 (" . t('Required') . ")
"; - echo '

'; - echo '

' . t('This will return brut text content.') . ' ' . - t('First line is the server capacity (in Bytes).') . '

'; - echo '

'; - echo t('Example') . ": " . $web_root . "script.php?get_capacity=1 "; - echo '

'; - - echo '

' . t('Maximal allowed size of an uploaded file') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "get_maximal_upload_size=1 (" . t('Required') . ")
"; - echo '

'; - echo '

' . t('This will return brut text content.') . ' ' . - t('First line returns size (in MB).') . '

'; - echo '

'; - echo t('Example') . ": " . $web_root . "script.php?get_maximal_upload_size=1 "; - echo '

'; - - echo '

' . t('Upload a file') . ':

'; - echo '

'; - echo t('Send a POST query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "file=C:\\your\\file\\path (" . t('Required') . ")
"; - echo "time=[minute|hour|day|week|month|year|none] (" . t('Optional') . ', '. t('default: none') . ")
"; - echo "password=your_password (" . t('Optional') . ")
"; - echo "one_time_download=1 (" . t('Optional') . ")
"; - echo "upload_password=your_upload_password (" . t('Optional') . ")
"; - echo '

'; - echo '

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

'; - - echo '

' . t('Get a file') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "h=your_download_reference (" . t('Required') . ")
"; - echo '

'; - echo '

'; - echo t('If a password has been set, send a POST request with it.'); - echo '
'; - echo t('Parameters') . ':
'; - echo "password=your_password (" . t('Optional') . ")
"; - echo '

'; - echo '

'; - echo t('Example') . ": " . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU "; - echo '

'; - - echo '

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

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "h=your_download_reference (" . t('Required') . ")
"; - echo "d=yout_delete_code (" . t('Required') . ")
"; - echo '

'; - echo '

' . t('This will return "Ok" if succeeded, "Error" otherwhise.') . '

'; - echo '

'; - echo t('Example') . ": " . $web_root . "script.php?h=30ngy0hsDcpfrF8zR7x9iU&d=0d210a952 "; - echo '

'; - - echo '

' . t('Get a generated script') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "lang=["; - foreach ($script_langages as $lang => $name) - echo $lang; - echo "] (" . t('Required') . ")
"; - echo '

'; - echo '

' . t('This will return brut text content of the code.') . '

'; - echo '

'; - echo t('Example') . ":
"; - foreach ($script_langages as $lang => $name) - echo "$name: " . $web_root . "script.php?lang=$lang "; - echo '

'; - - echo '

' . t('Initalize an asynchronous transfer') . ':

'; - echo '

'; - 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 '

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php?init_async
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "filename=file_name.ext (" . t('Required') . ")
"; - echo "type=MIME_TYPE (" . t('Optional') . ")
"; - echo "time=[minute|hour|day|week|month|year|none] (" . t('Optional') . ', '. t('default: none') . ")
"; - echo "password=your_password (" . t('Optional') . ")
"; - echo "one_time_download=1 (" . t('Optional') . ")
"; - echo "upload_password=your_upload_password (" . t('Optional') . ")
"; - echo '

'; - echo '

' . 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.') . '

'; - - echo '

' . t('Push data during asynchronous transfer') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php?push_async
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "ref=async_reference (" . t('Required') . ")
"; - echo "data=data_chunk (" . t('Required') . ")
"; - echo "code=last_provided_code (" . t('Required') . ")
"; - echo '

'; - echo '

' . t('This will return brut text content.') . ' ' . - t('Returns the next code to use.') . '

'; - - echo '

' . t('Finalize asynchronous transfer') . ':

'; - echo '

'; - echo t('Send a GET query to') . ': ' . $web_root . 'script.php?end_async
'; - echo '
'; - echo t('Parameters') . ':
'; - echo "ref=async_reference (" . t('Required') . ")
"; - echo "code=last_provided_code (" . t('Required') . ")
"; - echo '

'; - echo '

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

'; - - echo '

'; + ?> +
+

Scriting interface

+

This interface permits to script your uploads and downloads.

+

See source code of this interface to understand availablee calls :)

+
+
+