[FEATURE] Bash script: Enhance help and add version

[jirafeau_mojo42.git] / script.php

diff --git a/script.php b/script.php
index 8d6947b042815ed7e947b1d60d65b77ac5c2dba2..3905d2f4e16a963aa13fd612f991c3f41c711d7c 100644 (file)
--- a/script.php
+++ b/script.php
@@ -14,7 +14,7 @@
  *  GNU Affero General Public License for more details.
  *
  *  You should have received a copy of the GNU Affero General Public License
- *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 /*
@@ -52,9 +52,10 @@ if ($_SERVER['REQUEST_METHOD'] == "GET" && count ($_GET) == 0)
     }
     ?>
     <div class="info">
-    <h2>Scriting interface</h2>
+    <h2>Scripting 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>
+    <p>See <a href="https://gitlab.com/mojo42/Jirafeau/blob/master/script.php">source code</a> of this interface to get available calls :)</p>
+    <p>Alternatively, go to <a href="<?php echo $cfg['web_root'] . 'script.php?lang=bash'; ?>">this page</a> to download a bash script.</p>
     </div>
     <br />
     <?php
@@ -68,7 +69,7 @@ header('Content-Type: text; charset=utf-8');
 check_errors ($cfg);
 if (has_error ())
 {
-    echo "Error";
+    echo 'Error 1';
     exit;
 }
 
@@ -78,7 +79,7 @@ if (isset ($_FILES['file']) && is_writable (VAR_FILES)
 {
     if (!jirafeau_challenge_upload_ip ($cfg, get_ip_address($cfg)))
     {
-        echo "Error";
+        echo 'Error 2';
         exit;
     }
 
@@ -86,7 +87,7 @@ if (isset ($_FILES['file']) && is_writable (VAR_FILES)
          (!isset ($_POST['upload_password']) ||
           !jirafeau_challenge_upload_password ($cfg, $_POST['upload_password'])))
     {
-        echo "Error";
+        echo 'Error 3';
         exit;
     }
 
@@ -97,7 +98,7 @@ if (isset ($_FILES['file']) && is_writable (VAR_FILES)
     $time = time ();
     if (!isset ($_POST['time']) || !$cfg['availabilities'][$_POST['time']])
     {
-        echo "Error";
+        echo 'Error 4: The parameter time is invalid.';
         exit;
     }
     else
@@ -118,6 +119,9 @@ if (isset ($_FILES['file']) && is_writable (VAR_FILES)
             case 'month':
                 $time += JIRAFEAU_MONTH;
                 break;
+            case 'quarter':
+                $time += JIRAFEAU_QUARTER;
+                break;
             case 'year':
                 $time += JIRAFEAU_YEAR;
                 break;
@@ -130,7 +134,7 @@ if (isset ($_FILES['file']) && is_writable (VAR_FILES)
     if ($cfg['maximal_upload_size'] > 0 &&
         $_FILES['file']['size'] > $cfg['maximal_upload_size'] * 1024 * 1024)
     {
-        echo "Error";
+        echo 'Error 5: Your file exceeds the maximum authorized file size.';
         exit;
     }
 
@@ -138,10 +142,10 @@ if (isset ($_FILES['file']) && is_writable (VAR_FILES)
                             isset ($_POST['one_time_download']),
                             $key, $time, get_ip_address($cfg),
                             $cfg['enable_crypt'], $cfg['link_name_length']);
-    
+
     if (empty($res) || $res['error']['has_error'])
     {
-        echo "Error";
+        echo 'Error 6 ' . $res['error']['why'];
         exit;
     }
     /* Print direct link. */
@@ -162,17 +166,17 @@ elseif (isset ($_GET['h']))
     $d = '';
     if (isset ($_GET['d']))
         $d = $_GET['d'];
-    
+
     if (!preg_match ('/[0-9a-zA-Z_-]+$/', $link_name))
     {
-        echo "Error";
+        echo 'Error 7';
         exit;
     }
-    
+
     $link = jirafeau_get_link ($link_name);
     if (count ($link) == 0)
     {
-        echo "Error";
+        echo 'Error 8';
         exit;
     }
     if (strlen ($d) > 0 && $d == $link['link_code'])
@@ -184,18 +188,19 @@ elseif (isset ($_GET['h']))
     if ($link['time'] != JIRAFEAU_INFINITY && time () > $link['time'])
     {
         jirafeau_delete_link ($link_name);
-        echo "Error";
+        echo 'Error 9';
         exit;
     }
     if (strlen ($link['key']) > 0 && md5 ($key) != $link['key'])
     {
-        echo "Error";
+        sleep (2);
+        echo 'Error 10';
         exit;
     }
     $p = s2p ($link['md5']);
     if (!file_exists (VAR_FILES . $p . $link['md5']))
     {
-        echo "Error";
+        echo 'Error 11';
         exit;
     }
 
@@ -238,16 +243,15 @@ elseif (isset ($_GET['lang']))
 ?>
 #!/bin/bash
 
-# This script has been auto-generated by Jirafeau but you can still edit 
-# options below.
+# This script has been auto-generated by Jirafeau but you can still edit options below.
 
-# Config
-proxy='' # ex: proxy='proxysever.test.com:3128' or set JIRAFEAU_PROXY global variable
-url='<?php echo $cfg['web_root'] . 'script.php'; ?>' # or set JIRAFEAU_URL ex: url='http://mysite/jirafeau/script.php'
-time='none' # minute, hour, day, week, month, year or none. Or set JIRAFEAU_TIME.
-one_time='' # ex: one_time="1" or set JIRAFEAU_ONE_TIME.
-curl='' # curl path to download or set JIRAFEAU_CURL_PATH.
-# End of config
+# Config begin
+proxy='' # Or set JIRAFEAU_PROXY.
+url='<?php echo $cfg['web_root'] . 'script.php'; ?>' # Or set JIRAFEAU_URL.
+time='<?php echo $cfg['availability_default']; ?>' # Or set JIRAFEAU_TIME.
+one_time='' # Or set JIRAFEAU_ONE_TIME.
+curl='' # Or set JIRAFEAU_CURL_PATH.
+# Config end
 
 if [ -n "$JIRAFEAU_PROXY" ]; then
     proxy="$JIRAFEAU_PROXY"
@@ -287,17 +291,22 @@ if [ -z "$curl" ]; then
 fi
 
 if [ -z "$2" ]; then
-    echo "man:"
-    echo "    $0 send PATH [PASSWORD]"
+    echo "Jirafeau Bash Script <?php echo JIRAFEAU_VERSION; ?>"
+    echo "--------------------------"
+    echo "Usage:"
+    echo "    $0 OPTIONS"
+    echo
+    echo "Options:"
+    echo "    $0 send FILE [PASSWORD]"
     echo "    $0 get URL [PASSWORD]"
     echo "    $0 delete URL"
-    echo ""
+    echo
     echo "Global variables to export:"
-    echo "    JIRAFEAU_PROXY : example: proxysever.test.com:3128"
-    echo "    JIRAFEAU_URL : example: http://mysite/jirafeau/script.php"
-    echo "    JIRAFEAU_TIME : minute, hour, day, week, year, month or none"
-    echo "    JIRAFEAU_ONE_TIME : set anything or set empty"
-    echo "    JIRAFEAU_CURL : path to your curl binary"
+    echo "    JIRAFEAU_PROXY: Domain and port of proxy server, eg. »proxysever.example.com:3128«"
+    echo "    JIRAFEAU_URL : URI to Jirafeau installation and API page with trailing slash, eg. »https://example.com/jirafeau/script.php«"
+    echo "    JIRAFEAU_TIME : expiration time, eg. »minute«, »hour«, »day«, »week«, »month«, »quarter«, »year« or »none«"
+    echo "    JIRAFEAU_ONE_TIME : self-destroy after first download, eg. »1« to enable or »« (empty) to disable"
+    echo "    JIRAFEAU_CURL : alternative path to curl binary"
 
     exit 0
 fi
@@ -329,8 +338,9 @@ if [ "$1" == "send" ]; then
                   -F "file=@$2" \
                   $url)
 
-    if [[ "$res" == "Error" ]]; then
+    if [[ "$res" == Error* ]]; then
         echo "Error while uploading."
+        echo $res
         exit
     fi
 
@@ -347,7 +357,11 @@ if [ "$1" == "send" ]; then
         fi
         cnt=$(( cnt + 1 ))
         done)
+    echo "Download link:"
     echo "${url}?h=$code"
+    echo "Direct download link:"
+    echo "${url}?h=$code&d=1"
+    echo "Delete link:"
     echo "${url}?h=$code&d=$del_code"
 elif [ "$1" == "get" ]; then
     if [ -z "$password" ]; then
@@ -362,7 +376,7 @@ fi
     }
     else
     {
-        echo "Error";
+        echo 'Error 12';
         exit;
     }
 }
@@ -372,7 +386,7 @@ elseif (isset ($_GET['alias_create']))
     $ip = get_ip_address($cfg);
     if (!jirafeau_challenge_upload_ip ($cfg, $ip))
     {
-        echo "Error";
+        echo 'Error 13';
         exit;
     }
 
@@ -380,7 +394,7 @@ elseif (isset ($_GET['alias_create']))
          (!isset ($_POST['upload_password']) ||
           !jirafeau_challenge_upload_password ($cfg, $_POST['upload_password'])))
     {
-        echo "Error";
+        echo 'Error 14';
         exit;
     }
 
@@ -388,7 +402,7 @@ elseif (isset ($_GET['alias_create']))
         !isset ($_POST['destination']) ||
         !isset ($_POST['password']))
     {
-        echo "Error";
+        echo 'Error 15';
         exit;
     }
 
@@ -402,7 +416,7 @@ elseif (isset ($_GET['alias_get']))
 {
     if (!isset ($_POST['alias']))
     {
-        echo "Error";
+        echo 'Error 16';
         exit;
     }
 
@@ -415,7 +429,7 @@ elseif (isset ($_GET['alias_update']))
         !isset ($_POST['destination']) ||
         !isset ($_POST['password']))
     {
-        echo "Error";
+        echo 'Error 17';
         exit;
     }
 
@@ -435,7 +449,7 @@ elseif (isset ($_GET['alias_delete']))
     if (!isset ($_POST['alias']) ||
         !isset ($_POST['password']))
     {
-        echo "Error";
+        echo 'Error 18';
         exit;
     }
 
@@ -447,7 +461,7 @@ elseif (isset ($_GET['init_async']))
 {
     if (!jirafeau_challenge_upload_ip ($cfg, get_ip_address($cfg)))
     {
-        echo "Error";
+        echo 'Error 19';
         exit;
     }
 
@@ -455,20 +469,20 @@ elseif (isset ($_GET['init_async']))
          (!isset ($_POST['upload_password']) ||
           !jirafeau_challenge_upload_password ($cfg, $_POST['upload_password'])))
     {
-        echo "Error";
+        echo 'Error 20';
         exit;
     }
 
     if (!isset ($_POST['filename']))
     {
-        echo "Error";
+        echo 'Error 21';
         exit;
     }
 
     $type = '';
     if (isset ($_POST['type']))
         $type = $_POST['type'];
-    
+
     $key = '';
     if (isset ($_POST['key']))
         $key = $_POST['key'];
@@ -476,7 +490,7 @@ elseif (isset ($_GET['init_async']))
     $time = time ();
     if (!isset ($_POST['time']) || !$cfg['availabilities'][$_POST['time']])
     {
-        echo "Error";
+        echo 'Error 22';
         exit;
     }
     else
@@ -497,6 +511,9 @@ elseif (isset ($_GET['init_async']))
             case 'month':
                 $time += JIRAFEAU_MONTH;
                 break;
+            case 'quarter':
+                $time += JIRAFEAU_QUARTER;
+                break;
             case 'year':
                 $time += JIRAFEAU_YEAR;
                 break;
@@ -517,7 +534,7 @@ elseif (isset ($_GET['push_async']))
     if ((!isset ($_POST['ref']))
         || (!isset ($_FILES['data']))
         || (!isset ($_POST['code'])))
-        echo "Error";
+        echo 'Error 23';
     else
     {
         echo jirafeau_async_push ($_POST['ref'],
@@ -531,12 +548,11 @@ elseif (isset ($_GET['end_async']))
 {
     if (!isset ($_POST['ref'])
         || !isset ($_POST['code']))
-        echo "Error";
+        echo 'Error 24';
     else
         echo jirafeau_async_end ($_POST['ref'], $_POST['code'], $cfg['enable_crypt'], $cfg['link_name_length']);
 }
 else
-    echo "Error";
+    echo 'Error 25';
 exit;
 ?>
-