add an alias system to the API.

[jirafeau_project.git] / lib / functions.php

diff --git a/lib/functions.php b/lib/functions.php
index 2c799f28d4bdd4f10c21e4dd6a4a7a563770be1c..c0e0c72f61f05897ff83cda06275fa4e866ade48 100644 (file)
--- a/lib/functions.php
+++ b/lib/functions.php
@@ -770,7 +770,7 @@ jirafeau_get_async_ref ($ref)
 
 /**
  * Delete async transfert informations
 
 /**
  * Delete async transfert informations

-  */
+ */

 function
 jirafeau_async_delete ($ref)
 {
 function
 jirafeau_async_delete ($ref)
 {


@@ -1120,7 +1120,7 @@ function has_http_forwarded()
 
 /**
  * Generate IP list from HTTP headers generated by a proxy
 
 /**
  * Generate IP list from HTTP headers generated by a proxy

- * return  array of IP strings
+ * @return  array of IP strings

  */
 function get_ip_list_http_forwarded()
 {
  */
 function get_ip_list_http_forwarded()
 {


@@ -1147,7 +1147,7 @@ function get_ip_list_http_forwarded()
 /**
  * Get the ip address of the client from REMOTE_ADDR
  * or from HTTP_X_FORWARDED_FOR if behind a proxy
 /**
  * Get the ip address of the client from REMOTE_ADDR
  * or from HTTP_X_FORWARDED_FOR if behind a proxy

- * @returns an the client ip address
+ * @returns the client ip address

  */
 function get_ip_address($cfg) {
     $remote = $_SERVER['REMOTE_ADDR'];
  */
 function get_ip_address($cfg) {
     $remote = $_SERVER['REMOTE_ADDR'];


@@ -1178,3 +1178,172 @@ function hex_to_base64($hex)
         $b .= chr (hexdec ($pair));
     return base64_encode ($b);
 }
         $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";
+}
+