]> git.p6c8.net - jirafeau_mojo42.git/blobdiff - lib/functions.php
README.md: add documentation about 1.0 and 1.1 release
[jirafeau_mojo42.git] / lib / functions.php
index b26d7b43c96790ed017655120a8e0cec6b40b2a8..592e841997249d35616ab65cf8c97172ef2c7524 100644 (file)
@@ -2,7 +2,8 @@
 /*
  *  Jirafeau, your web file repository
  *  Copyright (C) 2008  Julien "axolotl" BERNARD <axolotl@magieeternelle.org>
- *  Copyright (C) 2012  Jerome Jutteau <j.jutteau@gmail.com>
+ *  Copyright (C) 2015  Jerome Jutteau <j.jutteau@gmail.com>
+ *  Copyright (C) 2015  Nicola Spanti (RyDroid) <dev@nicola-spanti.info>
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Affero General Public License as
  *  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/>.
  */
 
 /**
  * Transform a string in a path by seperating each letters by a '/'.
 * @return path finishing with a '/'
+ * @return path finishing with a '/'
  */
 function
 s2p ($s)
@@ -39,22 +40,22 @@ function
 base_16_to_64 ($num)
 {
     $m = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_';
-    $hex2bin = array ('0000', # 0
-                      '0001', # 1
-                      '0010', # 2
-                      '0011', # 3
-                      '0100', # 4
-                      '0101', # 5
-                      '0110', # 6
-                      '0111', # 7
-                      '1000', # 8
-                      '1001', # 9
-                      '1010', # a
-                      '1011', # b
-                      '1100', # c
-                      '1101', # d
-                      '1110', # e
-                      '1111'); # f
+    $hex2bin = array ('0000',  # 0
+                      '0001',  # 1
+                      '0010',  # 2
+                      '0011',  # 3
+                      '0100',  # 4
+                      '0101',  # 5
+                      '0110',  # 6
+                      '0111',  # 7
+                      '1000',  # 8
+                      '1001',  # 9
+                      '1010',  # a
+                      '1011',  # b
+                      '1100',  # c
+                      '1101',  # d
+                      '1110',  # e
+                      '1111'); # f
     $o = '';    
     $b = '';
     $i = 0;
@@ -90,14 +91,17 @@ jirafeau_gen_random ($l)
     return $code;
 }
 
-function is_ssl() {
+function
+is_ssl() {
     if ( isset($_SERVER['HTTPS']) ) {
-        if ( 'on' == strtolower($_SERVER['HTTPS']) )
-            return true;
-        if ( '1' == $_SERVER['HTTPS'] )
+        if ( 'on' == strtolower($_SERVER['HTTPS']) ||
+             '1' == $_SERVER['HTTPS'] )
             return true;
     } elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
         return true;
+    } elseif (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
+        if ($_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https')
+            return true;
     }
     return false;
 }
@@ -156,7 +160,8 @@ jirafeau_clean_rm_file ($md5)
  * @param $value the value from php.ini
  * @returns an integer for this value
  */
-function jirafeau_ini_to_bytes ($value)
+function
+jirafeau_ini_to_bytes ($value)
 {
     $modifier = substr ($value, -1);
     $bytes = substr ($value, 0, -1);
@@ -172,8 +177,6 @@ function jirafeau_ini_to_bytes ($value)
         $bytes *= 1024;
     case 'K':
         $bytes *= 1024;
-    default:
-        break;
     }
     return $bytes;
 }
@@ -214,23 +217,16 @@ jirafeau_upload_errstr ($code)
     case UPLOAD_ERR_INI_SIZE:
     case UPLOAD_ERR_FORM_SIZE:
         return t('Your file exceeds the maximum authorized file size. ');
-        break;
 
     case UPLOAD_ERR_PARTIAL:
     case UPLOAD_ERR_NO_FILE:
         return
-            t
-            ('Your file was not uploaded correctly. You may succeed in retrying. ');
-        break;
+            t('Your file was not uploaded correctly. You may succeed in retrying. ');
 
     case UPLOAD_ERR_NO_TMP_DIR:
     case UPLOAD_ERR_CANT_WRITE:
     case UPLOAD_ERR_EXTENSION:
         return t('Internal error. You may not succeed in retrying. ');
-        break;
-
-    default:
-        break;
     }
     return t('Unknown error. ');
 }
@@ -429,21 +425,21 @@ jirafeau_upload ($file, $one_time_download, $key, $time, $ip, $crypt, $link_name
         {
             jirafeau_clean_rm_file ($md5_link);
         }
-        return (array(
+        return array(
                  'error' =>
                    array ('has_error' => true,
                           'why' => t('Internal error during file creation. ')),
                  'link' =>'',
-                 'delete_link' => ''));
+                 'delete_link' => '');
     }
-   return (array ('error' => $noerr,
+   return array ( 'error' => $noerr,
                   'link' => $md5_link,
                   'delete_link' => $delete_link_code,
-                  'crypt_key' => $crypt_key));
+                  'crypt_key' => $crypt_key);
 }
 
 /**
- * tells if a mime-type is viewable in a browser
+ * Tells if a mime-type is viewable in a browser
  * @param $mime the mime type
  * @returns a boolean telling if a mime type is viewable
  */
@@ -453,7 +449,7 @@ jirafeau_is_viewable ($mime)
     if (!empty ($mime))
     {
         /* Actually, verify if mime-type is an image or a text. */
-        $viewable = array ('image', 'text');
+        $viewable = array ('image', 'text', 'video', 'audio');
         $decomposed = explode ('/', $mime);
         return in_array ($decomposed[0], $viewable);
     }
@@ -552,10 +548,7 @@ jirafeau_get_link ($hash)
     $out['upload_date'] = trim ($c[7]);
     $out['ip'] = trim ($c[8]);
     $out['link_code'] = trim ($c[9]);
-    if (trim ($c[10]) == 'C')
-           $out['crypted'] = true;
-    else
-           $out['crypted'] = false;
+    $out['crypted'] = trim ($c[10]) == 'C';
     
     return $out;
 }
@@ -611,7 +604,7 @@ jirafeau_admin_list ($name, $file_hash, $link_hash)
                     continue;
 
                 /* Filter. */
-                if (!empty ($name) && !preg_match ("/$name/i", $l['file_name']))
+                if (!empty ($name) && !preg_match ("/$name/i", htmlspecialchars($l['file_name'])))
                     continue;
                 if (!empty ($file_hash) && $file_hash != $l['md5'])
                     continue;
@@ -623,14 +616,19 @@ jirafeau_admin_list ($name, $file_hash, $link_hash)
                 '<form action = "admin.php" method = "post">' .
                 '<input type = "hidden" name = "action" value = "download"/>' .
                 '<input type = "hidden" name = "link" value = "' . $node . '"/>' .
-                '<input type = "submit" value = "' . $l['file_name'] . '" />' .
+                '<input type = "submit" value = "' . htmlspecialchars($l['file_name']) . '" />' .
                 '</form>';
                 echo '</td>';
                 echo '<td>' . $l['mime_type'] . '</td>';
                 echo '<td>' . jirafeau_human_size ($l['file_size']) . '</td>';
                 echo '<td>' . ($l['time'] == -1 ? '' : strftime ('%c', $l['time'])) .
                      '</td>';
-                echo '<td>' . $l['onetime'] . '</td>';
+                echo '<td>';
+                if ($l['onetime'] == 'O')
+                    echo 'Y';
+                else
+                    echo 'N';
+                echo '</td>';
                 echo '<td>' . strftime ('%c', $l['upload_date']) . '</td>';
                 echo '<td>' . $l['ip'] . '</td>';
                 echo '<td>' .
@@ -767,7 +765,7 @@ jirafeau_get_async_ref ($ref)
 
 /**
  * Delete async transfert informations
 */
+ */
 function
 jirafeau_async_delete ($ref)
 {
@@ -795,7 +793,7 @@ jirafeau_async_delete ($ref)
   * @param $key eventual password (or blank)
   * @param $time time limit
   * @param $ip ip address of the client
-  * @return  a string containing a temporary reference followed by a code or the string "Error"
+  * @return a string containing a temporary reference followed by a code or the string 'Error'
   */
 function
 jirafeau_async_init ($filename, $type, $one_time, $key, $time, $ip)
@@ -814,7 +812,7 @@ jirafeau_async_init ($filename, $type, $one_time, $key, $time, $ip)
     @mkdir ($p, 0755, true);
     if (!file_exists ($p))
     {
-        echo "Error";
+        echo 'Error';
         return;
     }
     
@@ -841,10 +839,11 @@ jirafeau_async_init ($filename, $type, $one_time, $key, $time, $ip)
   * @param $ref asynchronous upload reference
   * @param $file piece of data
   * @param $code client code for this operation
-  * @return  a string containing a next code to use or the string "Error"
+  * @param $max_file_size maximum allowed file size
+  * @return a string containing a next code to use or the string "Error"
   */
 function
-jirafeau_async_push ($ref, $data, $code)
+jirafeau_async_push ($ref, $data, $code, $max_file_size)
 {
     /* Get async infos. */
     $a = jirafeau_get_async_ref ($ref);
@@ -854,13 +853,25 @@ jirafeau_async_push ($ref, $data, $code)
         || $a['next_code'] != "$code"
         || empty ($data['tmp_name'])
         || !is_uploaded_file ($data['tmp_name']))
-        return "Error";
+        return 'Error';
     
     $p = s2p ($ref);
 
+    /* File path. */
+    $r_path = $data['tmp_name'];
+    $w_path = VAR_ASYNC . $p . $ref . '_data';
+
+    /* Check that file size is not above upload limit. */
+    if ($max_file_size > 0 &&
+        filesize ($r_path) + filesize ($w_path) > $max_file_size * 1024 * 1024)
+    {
+        jirafeau_async_delete ($ref);
+        return 'Error';
+    }
+
     /* Concatenate data. */
-    $r = fopen ($data['tmp_name'], 'r');
-    $w = fopen (VAR_ASYNC . $p . $ref . '_data', 'a');
+    $r = fopen ($r_path, 'r');
+    $w = fopen ($w_path, 'a');
     while (!feof ($r))
     {
         if (fwrite ($w, fread ($r, 1024)) === false)
@@ -868,12 +879,12 @@ jirafeau_async_push ($ref, $data, $code)
             fclose ($r);
             fclose ($w);
             jirafeau_async_delete ($ref);
-            return "Error";
+            return 'Error';
         }
     }
     fclose ($r);
     fclose ($w);
-    unlink ($data['tmp_name']);
+    unlink ($r_path);
     
     /* Update async file. */
     $code = jirafeau_gen_random (4);
@@ -891,8 +902,8 @@ jirafeau_async_push ($ref, $data, $code)
   * @param $ref asynchronous upload reference
   * @param $code client code for this operation
   * @param $crypt boolean asking to crypt or not
-  * @param $link_name_length link name lenght
-  * @return  a string containing the download reference followed by a delete code or the string "Error"
+  * @param $link_name_length link name length
+  * @return a string containing the download reference followed by a delete code or the string 'Error'
   */
 function
 jirafeau_async_end ($ref, $code, $crypt, $link_name_length)
@@ -906,7 +917,7 @@ jirafeau_async_end ($ref, $code, $crypt, $link_name_length)
     /* Generate link infos. */
     $p = VAR_ASYNC . s2p ($ref) . $ref . "_data";
     if (!file_exists($p))
-        return "Error";
+        return 'Error';
 
     $crypted = false;
     $crypt_key = '';
@@ -1018,7 +1029,7 @@ function
 jirafeau_decrypt_file ($fp_src, $fp_dst, $k)
 {
     $fs = filesize ($fp_src);
-    if ($fs === false || $fs == 0 || !(extension_loaded('mcrypt') == true))
+    if ($fs === false || $fs == 0 || extension_loaded('mcrypt') == false)
         return false;
 
     /* Init module */
@@ -1048,7 +1059,8 @@ jirafeau_decrypt_file ($fp_src, $fp_dst, $k)
  * Check if Jirafeau is password protected for visitors.
  * @return true if Jirafeau is password protected, false otherwise.
  */
-function jirafeau_has_upload_password ($cfg)
+function
+jirafeau_has_upload_password ($cfg)
 {
     return count ($cfg['upload_password']) > 0;
 }
@@ -1058,7 +1070,8 @@ function jirafeau_has_upload_password ($cfg)
  * @param $password password to be challenged
  * @return true if password is valid, false otherwise.
  */
-function jirafeau_challenge_upload_password ($cfg, $password)
+function
+jirafeau_challenge_upload_password ($cfg, $password)
 {
     if (!jirafeau_has_upload_password($cfg))
         return false;
@@ -1068,3 +1081,279 @@ function jirafeau_challenge_upload_password ($cfg, $password)
     return false;
 }
 
+/**
+ * Test if visitor's IP is authorized to upload.
+ * @param $ip IP to be challenged
+ * @return true if IP is authorized, false otherwise.
+ */
+function
+jirafeau_challenge_upload_ip ($cfg, $ip)
+{
+    if (count ($cfg['upload_ip']) == 0)
+        return true;
+    forEach ($cfg['upload_ip'] as $i)
+    {
+        if ($i == $ip)
+            return true;
+        // CIDR test for IPv4 only.
+        if (strpos ($i, '/') !== false)
+        {
+            list ($subnet, $mask) = explode('/', $i);
+            if ((ip2long ($ip) & ~((1 << (32 - $mask)) - 1) ) == ip2long ($subnet))
+                return true;
+        }
+    }
+    return false;
+}
+
+/** Tell if we have some HTTP headers generated by a proxy */
+function
+has_http_forwarded()
+{
+    return
+        !empty ($_SERVER['HTTP_X_FORWARDED_FOR']) ||
+        !empty ($_SERVER['http_X_forwarded_for']);
+}
+
+/**
+ * Generate IP list from HTTP headers generated by a proxy
+ * @return  array of IP strings
+ */
+function
+get_ip_list_http_forwarded()
+{
+    $ip_list = array();
+    if (!empty ($_SERVER['HTTP_X_FORWARDED_FOR']))
+    {
+        $l = explode (',', $_SERVER['HTTP_X_FORWARDED_FOR']);
+        if ($l === FALSE)
+            return array();
+        foreach ($l as $ip)
+            array_push ($ip_list, preg_replace ('/\s+/', '', $ip));
+    }
+    if (!empty ($_SERVER['http_X_forwarded_for']))
+    {
+        $l = explode (',', $_SERVER['http_X_forwarded_for']);
+        foreach ($l as $ip)
+        {
+            // Separate IP from port
+            $ipa = explode (':', $ip);
+            if ($ipa === FALSE)
+                continue;
+            $ip = $ipa[0];
+            array_push ($ip_list, preg_replace ('/\s+/', '', $ip));
+        }
+    }
+    return $ip_list;
+}
+
+/**
+ * Get the ip address of the client from REMOTE_ADDR
+ * or from HTTP_X_FORWARDED_FOR if behind a proxy
+ * @returns the client ip address
+ */
+function
+get_ip_address($cfg)
+{
+    $remote = $_SERVER['REMOTE_ADDR'];
+    if (count ($cfg['proxy_ip']) == 0 || !has_http_forwarded ())
+        return $remote;
+
+    $ip_list = get_ip_list_http_forwarded ();
+    if (count ($ip_list) == 0)
+        return $remote;
+
+    foreach ($cfg['proxy_ip'] as $proxy_ip)
+    {
+        if ($remote != $proxy_ip)
+            continue;
+        // Take the last IP (the one which has been set by the defined proxy).
+        return end ($ip_list);
+    }
+    return $remote;
+}
+
+/**
+ * Convert hexadecimal string to base64
+ */
+function hex_to_base64($hex)
+{
+    $b = '';
+    foreach (str_split ($hex, 2) as $pair)
+        $b .= chr (hexdec ($pair));
+    return base64_encode ($b);
+}
+
+/**
+ * Read alias informations
+ * @return array containing informations.
+ */
+function
+jirafeau_get_alias ($hash)
+{
+    $out = array ();
+    $link = VAR_ALIAS . s2p ("$hash") . $hash;
+
+    if (!file_exists ($link))
+        return $out;
+    
+    $c = file ($link);
+    $out['md5_password'] = trim ($c[0]);
+    $out['ip'] = trim ($c[1]);
+    $out['update_date'] = trim ($c[2]);
+    $out['destination'] = trim ($c[3], NL);
+   
+    return $out;
+}
+
+/** Create an alias to a jirafeau's link.
+ * @param $alias alias name
+ * @param $destination reference of the destination
+ * @param $password password to protect alias
+ * @param $ip client's IP
+ * @return  a string containing the edit code of the alias or the string "Error"
+ */
+function
+jirafeau_alias_create ($alias, $destination, $password, $ip)
+{
+    /* Check that alias and password are long enough. */
+    if (strlen ($alias) < 8 ||
+        strlen ($alias) > 32 ||
+        strlen ($password) < 8 ||
+        strlen ($password) > 32)
+        return 'Error';
+
+    /* Check that destination exists. */
+    $l = jirafeau_get_link ($destination);
+    if (!count ($l))
+        return 'Error';
+
+    /* Check that alias does not already exists. */
+    $alias = md5 ($alias);
+    $p = VAR_ALIAS . s2p ($alias);
+    if (file_exists ($p))
+        return 'Error';
+    
+    /* Create alias folder. */
+    @mkdir ($p, 0755, true);
+    if (!file_exists ($p))
+        return 'Error';
+    
+    /* Generate password. */
+    $md5_password = md5 ($password);
+
+    /* Store informations. */
+    $p .= $alias;
+    $handle = fopen ($p, 'w');
+    fwrite ($handle,
+            $md5_password . NL .
+            $ip . NL .
+            date ('U') . NL .
+            $destination . NL);
+    fclose ($handle);
+
+    return 'Ok';
+}
+
+/** Update an alias.
+ * @param $alias alias to update
+ * @param $destination reference of the new destination
+ * @param $password password to protect alias
+ * @param $new_password optional new password to protect alias
+ * @param $ip client's IP
+ * @return "Ok" or "Error" string
+ */
+function
+jirafeau_alias_update ($alias, $destination, $password,
+                       $new_password, $ip)
+{
+    $alias = md5 ($alias);
+    /* Check that alias exits. */
+    $a = jirafeau_get_alias ($alias);
+    if (!count ($a))
+        return 'Error';
+
+    /* Check that destination exists. */
+    $l = jirafeau_get_link ($a["destination"]);
+    if (!count ($l))
+        return 'Error';
+
+    /* Check password. */
+    if ($a["md5_password"] != md5 ($password))
+        return 'Error';
+
+    $p = $a['md5_password'];
+    if (strlen ($new_password) >= 8 &&
+        strlen ($new_password) <= 32)
+        $p = md5 ($new_password);
+    else if (strlen ($new_password) > 0)
+        return 'Error';
+
+    /* Rewrite informations. */
+    $p = VAR_ALIAS . s2p ($alias) . $alias;
+    $handle = fopen ($p, 'w');
+    fwrite ($handle,
+            $p . NL .
+            $ip . NL .
+            date ('U') . NL .
+            $destination . NL);
+    fclose ($handle);
+    return 'Ok';
+}
+
+/** Get an alias.
+ * @param $alias alias to get
+ * @return alias destination or "Error" string
+ */
+function
+jirafeau_alias_get ($alias)
+{
+    $alias = md5 ($alias);
+    /* Check that alias exits. */
+    $a = jirafeau_get_alias ($alias);
+    if (!count ($a))
+        return 'Error';
+
+    return $a['destination'];
+}
+
+function
+jirafeau_clean_rm_alias ($alias)
+{
+    $p = s2p ("$alias");
+    if (file_exists (VAR_ALIAS . $p . $alias))
+        unlink (VAR_ALIAS . $p . $alias);
+    $parse = VAR_ALIAS . $p;
+    $scan = array();
+    while (file_exists ($parse)
+           && ($scan = scandir ($parse))
+           && count ($scan) == 2 // '.' and '..' folders => empty.
+           && basename ($parse) != basename (VAR_ALIAS)) 
+    {
+        rmdir ($parse);
+        $parse = substr ($parse, 0, strlen($parse) - strlen(basename ($parse)) - 1);
+    }
+}
+
+/** Delete an alias.
+ * @param $alias alias to delete
+ * @param $password password to protect alias
+ * @return "Ok" or "Error" string
+ */
+function
+jirafeau_alias_delete ($alias, $password)
+{
+    $alias = md5 ($alias);
+    /* Check that alias exits. */
+    $a = jirafeau_get_alias ($alias);
+    if (!count ($a))
+        return "Error";
+
+    /* Check password. */
+    if ($a["md5_password"] != md5 ($password))
+        return 'Error';
+
+    jirafeau_clean_rm_alias ($alias);
+    return 'Ok';
+}
+

patrick-canterino.de