]> git.p6c8.net - jirafeau.git/blobdiff - lib/functions.php
NEWCOMER.txt: fixed documentation
[jirafeau.git] / lib / functions.php
index 97733d598d199f2c04eb10f91543427e59cecc5c..c2cad4653d209eab87a083dff6e359f90644f9d1 100644 (file)
@@ -2,7 +2,7 @@
 /*
  *  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>
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Affero General Public License as
@@ -31,6 +31,80 @@ s2p ($s)
     return $p;
 }
 
+/**
+ * Convert base 16 to base 64
+ * @returns A string based on 64 characters (0-9, a-z, A-Z, "-" and "_")
+ */
+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
+    $o = '';    
+    $b = '';
+    $i = 0;
+    # Convert long hex string to bin.
+    $size = strlen ($num);
+    for ($i = 0; $i < $size; $i++)
+        $b .= $hex2bin{hexdec ($num{$i})};
+    # Convert long bin to base 64.
+    $size *= 4;
+    for ($i = $size - 6; $i >= 0; $i -= 6)
+        $o = $m{bindec (substr ($b, $i, 6))} . $o;
+    # Some few bits remaining ?
+    if ($i < 0 && $i > -6)
+        $o = $m{bindec (substr ($b, 0, $i + 6))} . $o;
+    return $o;
+}
+
+/**
+  * Generate a random code.
+  * @param $l code length
+  * @return  random code.
+  */
+function
+jirafeau_gen_random ($l)
+{
+    if ($l <= 0)
+        return 42;
+
+    $code="";
+    for ($i = 0; $i < $l; $i++)
+        $code .= dechex (rand (0, 15));
+
+    return $code;
+}
+
+function is_ssl() {
+    if ( isset($_SERVER['HTTPS']) ) {
+        if ( 'on' == strtolower($_SERVER['HTTPS']) )
+            return true;
+        if ( '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;
+}
+
 function
 jirafeau_human_size ($octets)
 {
@@ -63,10 +137,11 @@ function
 jirafeau_clean_rm_file ($md5)
 {
     $p = s2p ("$md5");
-    if (file_exists (VAR_FILES . $p . $md5))
-        unlink (VAR_FILES . $p . $md5);
-    if (file_exists (VAR_FILES . $p . $md5 . '_count'))
-        unlink (VAR_FILES . $p . $md5 . '_count');
+    $f = VAR_FILES . $p . $md5;
+    if (file_exists ($f) && is_file ($f))
+        unlink ($f);
+    if (file_exists ($f . '_count') && is_file ($f . '_count'))
+        unlink ($f . '_count');
     $parse = VAR_FILES . $p;
     $scan = array();
     while (file_exists ($parse)
@@ -106,6 +181,17 @@ function jirafeau_ini_to_bytes ($value)
     return $bytes;
 }
 
+/**
+ * gets the maximum upload size according to php.ini
+ * @returns the maximum upload size in bytes
+ */
+function
+jirafeau_get_max_upload_size_bytes ()
+{
+    return min (jirafeau_ini_to_bytes (ini_get ('post_max_size')),
+                jirafeau_ini_to_bytes (ini_get ('upload_max_filesize')));
+}
+
 /**
  * gets the maximum upload size according to php.ini
  * @returns the maximum upload size string
@@ -236,13 +322,15 @@ jirafeau_delete_file ($md5)
  * @param $key if not empty, protect the file with this key
  * @param $time the time of validity of the file
  * @param $ip uploader's ip
+ * @param $crypt boolean asking to crypt or not
+ * @param $link_name_length size of the link name
  * @returns an array containing some information
  *   'error' => information on possible errors
  *   'link' => the link name of the uploaded file
  *   'delete_link' => the link code to delete file
  */
 function
-jirafeau_upload ($file, $one_time_download, $key, $time, $ip)
+jirafeau_upload ($file, $one_time_download, $key, $time, $ip, $crypt, $link_name_length)
 {
     if (empty ($file['tmp_name']) || !is_uploaded_file ($file['tmp_name']))
     {
@@ -257,9 +345,21 @@ jirafeau_upload ($file, $one_time_download, $key, $time, $ip)
     /* array representing no error */
     $noerr = array ('has_error' => false, 'why' => '');
 
+    /* Crypt file if option is enabled. */
+    $crypted = false;
+    $crypt_key = '';
+    if ($crypt == true && !(extension_loaded('mcrypt') == true))
+        error_log ("PHP extension mcrypt not loaded, won't encrypt in Jirafeau");
+    if ($crypt == true && extension_loaded('mcrypt') == true)
+    {
+        $crypt_key = jirafeau_encrypt_file ($file['tmp_name'], $file['tmp_name']);
+        if (strlen($crypt_key) > 0)
+            $crypted = true;
+    }
+
     /* file informations */
     $md5 = md5_file ($file['tmp_name']);
-    $name = trim ($file['name']);
+    $name = str_replace (NL, '', trim ($file['name']));
     $mime_type = $file['type'];
     $size = $file['size'];
 
@@ -285,7 +385,7 @@ jirafeau_upload ($file, $one_time_download, $key, $time, $ip)
                  'delete_link' => ''));
     }
 
-    /* increment or create count file */
+    /* Increment or create count file. */
     $counter = 0;
     if (file_exists (VAR_FILES . $p . $md5 . '_count'))
     {
@@ -298,24 +398,22 @@ jirafeau_upload ($file, $one_time_download, $key, $time, $ip)
     fclose ($handle);
 
     /* Create delete code. */
-    $delete_link_code = 0;
-    for ($i = 0; $i < 8; $i++)
-        $delete_link_code .= dechex (rand (0, 16));
+    $delete_link_code = jirafeau_gen_random (5);
 
-    /* md5 password or empty */
+    /* md5 password or empty. */
     $password = '';
     if (!empty ($key))
         $password = md5 ($key);
 
     /* create link file */
-    $link_tmp_name =  VAR_LINKS . $md5 . rand (0, 10000) . ' .tmp';
+    $link_tmp_name =  VAR_LINKS . $md5 . rand (0, 10000) . '.tmp';
     $handle = fopen ($link_tmp_name, 'w');
     fwrite ($handle,
             $name . NL. $mime_type . NL. $size . NL. $password . NL. $time .
-            NL . $md5. NL . ($one_time_download ? 'O' : 'R') . NL.date ('U') .
-            NL. $ip . NL. $delete_link_code . NL);
+            NL . $md5. NL . ($one_time_download ? 'O' : 'R') . NL . date ('U') .
+            NL . $ip . NL. $delete_link_code . NL . ($crypted ? 'C' : 'O'));
     fclose ($handle);
-    $md5_link = md5_file ($link_tmp_name);
+    $md5_link = substr(base_16_to_64 (md5_file ($link_tmp_name)), 0, $link_name_length);
     $l = s2p ("$md5_link");
     if (!@mkdir (VAR_LINKS . $l, 0755, true) ||
         !rename ($link_tmp_name,  VAR_LINKS . $l . $md5_link))
@@ -343,11 +441,12 @@ jirafeau_upload ($file, $one_time_download, $key, $time, $ip)
     }
    return (array ('error' => $noerr,
                   'link' => $md5_link,
-                  'delete_link' => $delete_link_code));
+                  'delete_link' => $delete_link_code,
+                  '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
  */
@@ -357,14 +456,13 @@ 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);
     }
     return false;
 }
 
-
 // Error handling functions.
 //! Global array that contains all registered errors.
 $error_list = array ();
@@ -410,6 +508,29 @@ show_errors ()
     }
 }
 
+function check_errors ($cfg)
+{
+    if (file_exists (JIRAFEAU_ROOT . 'install.php')
+        && !($cfg['installation_done'] === true))
+    {
+        header('Location: install.php'); 
+        exit;
+    }
+
+    /* check if the destination dirs are writable */
+    $writable = is_writable (VAR_FILES) && is_writable (VAR_LINKS);
+
+    /* Checking for errors. */
+    if (!is_writable (VAR_FILES))
+        add_error (t('The file directory is not writable!'), VAR_FILES);
+
+    if (!is_writable (VAR_LINKS))
+        add_error (t('The link directory is not writable!'), VAR_LINKS);
+    
+    if (!is_writable (VAR_ASYNC))
+        add_error (t('The async directory is not writable!'), VAR_ASYNC);
+}
+
 /**
  * Read link informations
  * @return array containing informations.
@@ -434,6 +555,10 @@ 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;
     
     return $out;
 }
@@ -574,4 +699,388 @@ jirafeau_admin_clean ()
     }
     return $count;
 }
-?>
+
+
+/**
+ * Clean old async transferts.
+ * @return number of cleaned files.
+ */
+function
+jirafeau_admin_clean_async ()
+{
+    $count = 0;
+    /* Get all links files. */
+    $stack = array (VAR_ASYNC);
+    while (($d = array_shift ($stack)) && $d != NULL)
+    {
+        $dir = scandir ($d);
+
+        foreach ($dir as $node)
+        {
+            if (strcmp ($node, '.') == 0 || strcmp ($node, '..') == 0 ||
+                preg_match ('/\.tmp/i', "$node"))
+                continue;
+            
+            if (is_dir ($d . $node))
+            {
+                /* Push new found directory. */
+                $stack[] = $d . $node . '/';
+            }
+            elseif (is_file ($d . $node))
+            {
+                /* Read async informations. */
+                $a = jirafeau_get_async_ref (basename ($node));
+                if (!count ($a))
+                    continue;
+                /* Delete transferts older than 1 hour. */
+                if (date ('U') - $a['last_edited'] > 3600)
+                {
+                    jirafeau_async_delete (basename ($node));
+                    $count++;
+                }
+            }
+        }
+    }
+    return $count;
+}
+/**
+ * Read async transfert informations
+ * @return array containing informations.
+ */
+function
+jirafeau_get_async_ref ($ref)
+{
+    $out = array ();
+    $refinfos = VAR_ASYNC . s2p ("$ref") . "$ref";
+
+    if (!file_exists ($refinfos))
+        return $out;
+    
+    $c = file ($refinfos);
+    $out['file_name'] = trim ($c[0]);
+    $out['mime_type'] = trim ($c[1]);
+    $out['key'] = trim ($c[2], NL);
+    $out['time'] = trim ($c[3]);
+    $out['onetime'] = trim ($c[4]);
+    $out['ip'] = trim ($c[5]);
+    $out['last_edited'] = trim ($c[6]);
+    $out['next_code'] = trim ($c[7]);
+    return $out;
+}
+
+/**
+ * Delete async transfert informations
+  */
+function
+jirafeau_async_delete ($ref)
+{
+    $p = s2p ("$ref");
+    if (file_exists (VAR_ASYNC . $p . $ref))
+        unlink (VAR_ASYNC . $p . $ref);
+    if (file_exists (VAR_ASYNC . $p . $ref . '_data'))
+        unlink (VAR_ASYNC . $p . $ref . '_data');
+    $parse = VAR_ASYNC . $p;
+    $scan = array();
+    while (file_exists ($parse)
+           && ($scan = scandir ($parse))
+           && count ($scan) == 2 // '.' and '..' folders => empty.
+           && basename ($parse) != basename (VAR_ASYNC)) 
+    {
+        rmdir ($parse);
+        $parse = substr ($parse, 0, strlen($parse) - strlen(basename ($parse)) - 1);
+    }
+}
+
+/**
+  * Init a new asynchronous upload.
+  * @param $finename Name of the file to send
+  * @param $one_time One time upload parameter
+  * @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"
+  */
+function
+jirafeau_async_init ($filename, $type, $one_time, $key, $time, $ip)
+{
+    $res = 'Error';
+
+    /* Create temporary folder. */
+    $ref;
+    $p;
+    $code = jirafeau_gen_random (4);
+    do
+    {
+        $ref = jirafeau_gen_random (32);
+        $p = VAR_ASYNC . s2p ($ref);
+    } while (file_exists ($p));
+    @mkdir ($p, 0755, true);
+    if (!file_exists ($p))
+    {
+        echo "Error";
+        return;
+    }
+    
+    /* md5 password or empty */
+    $password = '';
+    if (!empty ($key))
+        $password = md5 ($key);
+
+    /* Store informations. */
+    $p .= $ref;
+    $handle = fopen ($p, 'w');
+    fwrite ($handle,
+            str_replace (NL, '', trim ($filename)) . NL .
+            str_replace (NL, '', trim ($type)) . NL . $password . NL .
+            $time . NL . ($one_time ? 'O' : 'R') . NL . $ip . NL .
+            date ('U') . NL . $code . NL);
+    fclose ($handle);
+
+    return $ref . NL . $code ;
+}
+
+/**
+  * Append a piece of file on the asynchronous upload.
+  * @param $ref asynchronous upload reference
+  * @param $file piece of data
+  * @param $code client code for this operation
+  * @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, $max_file_size)
+{
+    /* Get async infos. */
+    $a = jirafeau_get_async_ref ($ref);
+    
+    /* Check some errors. */
+    if (count ($a) == 0
+        || $a['next_code'] != "$code"
+        || empty ($data['tmp_name'])
+        || !is_uploaded_file ($data['tmp_name']))
+        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 ($r_path, 'r');
+    $w = fopen ($w_path, 'a');
+    while (!feof ($r))
+    {
+        if (fwrite ($w, fread ($r, 1024)) === false)
+        {
+            fclose ($r);
+            fclose ($w);
+            jirafeau_async_delete ($ref);
+            return "Error";
+        }
+    }
+    fclose ($r);
+    fclose ($w);
+    unlink ($r_path);
+    
+    /* Update async file. */
+    $code = jirafeau_gen_random (4);
+    $handle = fopen (VAR_ASYNC . $p . $ref, 'w');
+    fwrite ($handle,
+            $a['file_name'] . NL. $a['mime_type'] . NL. $a['key'] . NL .
+            $a['time'] . NL . $a['onetime'] . NL . $a['ip'] . NL .
+            date ('U') . NL . $code . NL);
+    fclose ($handle);
+    return $code;
+}
+
+/**
+  * Finalyze an asynchronous upload.
+  * @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 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)
+{
+    /* Get async infos. */
+    $a = jirafeau_get_async_ref ($ref);
+    if (count ($a) == 0
+        || $a['next_code'] != "$code")
+        return "Error";
+    
+    /* Generate link infos. */
+    $p = VAR_ASYNC . s2p ($ref) . $ref . "_data";
+    if (!file_exists($p))
+        return "Error";
+
+    $crypted = false;
+    $crypt_key = '';
+    if ($crypt == true && extension_loaded('mcrypt') == true)
+    {
+        $crypt_key = jirafeau_encrypt_file ($p, $p);
+        if (strlen($crypt_key) > 0)
+            $crypted = true;
+    }
+
+    $md5 = md5_file ($p);
+    $size = filesize($p);
+    $np = s2p ($md5);
+    $delete_link_code = jirafeau_gen_random (5);
+    
+    /* File already exist ? */ 
+    if (!file_exists (VAR_FILES . $np))
+        @mkdir (VAR_FILES . $np, 0755, true);
+    if (!file_exists (VAR_FILES . $np . $md5))
+        rename ($p, VAR_FILES . $np . $md5);
+    
+    /* Increment or create count file. */
+    $counter = 0;
+    if (file_exists (VAR_FILES . $np . $md5 . '_count'))
+    {
+        $content = file (VAR_FILES . $np . $md5. '_count');
+        $counter = trim ($content[0]);
+    }
+    $counter++;
+    $handle = fopen (VAR_FILES . $np . $md5. '_count', 'w');
+    fwrite ($handle, $counter);
+    fclose ($handle);
+    
+    /* Create link. */
+    $link_tmp_name =  VAR_LINKS . $md5 . rand (0, 10000) . '.tmp';
+    $handle = fopen ($link_tmp_name, 'w');
+    fwrite ($handle,
+            $a['file_name'] . NL . $a['mime_type'] . NL . $size . NL .
+            $a['key'] . NL . $a['time'] . NL . $md5 . NL . $a['onetime'] . NL .
+            date ('U') . NL . $a['ip'] . NL . $delete_link_code . NL . ($crypted ? 'C' : 'O'));
+    fclose ($handle);
+    $md5_link = substr(base_16_to_64 (md5_file ($link_tmp_name)), 0, $link_name_length);
+    $l = s2p ("$md5_link");
+    if (!@mkdir (VAR_LINKS . $l, 0755, true) ||
+        !rename ($link_tmp_name,  VAR_LINKS . $l . $md5_link))
+        echo "Error";
+    
+    /* Clean async upload. */
+    jirafeau_async_delete ($ref);
+    return $md5_link . NL . $delete_link_code . NL . urlencode($crypt_key);
+}
+
+function
+jirafeau_crypt_create_iv($base, $size)
+{
+    $iv = '';
+    while (strlen ($iv) < $size)
+        $iv = $iv . $base;
+    $iv = substr($iv, 0, $size);
+    return $iv;
+}
+
+/**
+ * Crypt file and returns decrypt key.
+ * @param $fp_src file path to the file to crypt.
+ * @param $fp_dst file path to the file to write crypted file (could be the same).
+ * @return decrypt key composed of the key and the iv separated by a point ('.')
+ */
+function
+jirafeau_encrypt_file ($fp_src, $fp_dst)
+{
+    $fs = filesize ($fp_src);
+    if ($fs === false || $fs == 0 || !(extension_loaded('mcrypt') == true))
+        return '';
+
+    /* Prepare module. */
+    $m = mcrypt_module_open('rijndael-256', '', 'ofb', '');
+    /* Generate key. */
+    $crypt_key = jirafeau_gen_random (10);
+    $md5_key = md5($crypt_key);
+    $iv = jirafeau_crypt_create_iv ($md5_key, mcrypt_enc_get_iv_size($m));
+    /* Init module. */
+    mcrypt_generic_init($m, $md5_key, $iv);
+    /* Crypt file. */
+    $r = fopen ($fp_src, 'r');
+    $w = fopen ($fp_dst, 'c');
+    while (!feof ($r))
+    {
+        $enc = mcrypt_generic($m, fread ($r, 1024));
+        if (fwrite ($w, $enc) === false)
+            return '';
+    }
+    fclose ($r);
+    fclose ($w);
+    /* Cleanup. */
+    mcrypt_generic_deinit($m);
+    mcrypt_module_close($m);
+    return $crypt_key;
+}
+
+/**
+ * Decrypt file.
+ * @param $fp_src file path to the file to decrypt.
+ * @param $fp_dst file path to the file to write decrypted file (could be the same).
+ * @param $k string composed of the key and the iv separated by a point ('.')
+ * @return key used to decrypt. a string of length 0 is returned if failed.
+ */
+function
+jirafeau_decrypt_file ($fp_src, $fp_dst, $k)
+{
+    $fs = filesize ($fp_src);
+    if ($fs === false || $fs == 0 || !(extension_loaded('mcrypt') == true))
+        return false;
+
+    /* Init module */
+    $m = mcrypt_module_open('rijndael-256', '', 'ofb', '');
+    /* Extract key and iv. */
+    $crypt_key = $k;
+    $md5_key = md5($crypt_key);
+    $iv = jirafeau_crypt_create_iv ($md5_key, mcrypt_enc_get_iv_size($m));
+    /* Decrypt file. */
+    $r = fopen ($fp_src, 'r');
+    $w = fopen ($fp_dst, 'c');
+    while (!feof ($r))
+    {
+        $dec = mdecrypt_generic($m, fread ($r, 1024));
+        if (fwrite ($w, $dec) === false)
+            return false;
+    }
+    fclose ($r);
+    fclose ($w);
+    /* Cleanup. */
+    mcrypt_generic_deinit($m);
+    mcrypt_module_close($m);
+    return true;
+}
+
+/**
+ * Check if Jirafeau is password protected for visitors.
+ * @return true if Jirafeau is password protected, false otherwise.
+ */
+function jirafeau_has_upload_password ($cfg)
+{
+    return count ($cfg['upload_password']) > 0;
+}
+
+/**
+ * Challenge password for a visitor.
+ * @param $password password to be challenged
+ * @return true if password is valid, false otherwise.
+ */
+function jirafeau_challenge_upload_password ($cfg, $password)
+{
+    if (!jirafeau_has_upload_password($cfg))
+        return false;
+    forEach ($cfg['upload_password'] as $p)
+        if ($password == $p)
+            return true;
+    return false;
+}
+

patrick-canterino.de