Notifications V3 API implemented.

www/API/v3/notifications.php

@@ -1,11 +1,5 @@
 <?php
-    // Gasteizko Margolariak API v1 //
-
-    //List of available data formatting
-    define('FOR_JSON', 'json');
-
-    //Default info format
-    define('DEF_FORMAT', FOR_JSON);
+    // Gasteizko Margolariak API v3 //
 
     //Posible notification target
     define('TARGET_ALL', 'all');
@@ -15,25 +9,18 @@
     define('DEF_TARGET', TARGET_ALL);
 
     //$_GET valid parameters
-    define('GET_CLIENT', 'client');
-    define('GET_USER', 'user');
     define('GET_TARGET', 'target');
-    define('GET_FORMAT', 'json');
 
     //Error messages
     define('ERR_TARGET', '-TARGET:');
-    define('ERR_FORMAT', '-FORMAT:');
 
-    /****************************************************
-    * This function is called from almost everywhere at *
-    * the beggining of the page. It initializes the     *
-    * session variables, connect to the db, enabling    *
-    * the variable $con for futher use everywhere in    *
-    * the php code, and populates the arrays $user      *
-    * and $permission, with info about the user.        *
-    *                                                   *
-    * @return: (db connection): The connection handler. *
-    ****************************************************/
+    /*****************************************************
+     * Initializes the session variables and connects to * 
+     * the db.                                           *
+     *                                                   *
+     * @return: (MySQL server connection): The           *
+     *           connection handler.                     *
+     *****************************************************/
     function startdb(){
         //Include the db configuration file. It's somehow like this
         /*
@@ -47,20 +34,59 @@
         ?>
         */
         include('../../.htpasswd');
-        
+
         //Connect to to database
         $con = mysqli_connect($host, $username_rw, $pass_rw, $db_name);
-        
+
         //Set encoding options
         mysqli_set_charset($con, 'utf-8');
         header('Content-Type: text/html; charset=utf8');
         mysqli_query($con, 'SET NAMES utf8;');
-        
+
         //Return the db connection
         return $con;
     }
-    
-    function show_notifications($con, $target = DEF_TARGET, $format = DEF_FORMAT){
+
+    /*****************************************************
+     * Discerns the type of notificatios to look for     *
+     * using the parameter 'target' from the list of get *
+     * arguments. Valid values are 'all'or 'gm'. The     *
+     * default is 'all'.                                 *
+     *                                                   *
+     * @params:                                          *
+     *    get: (String array) List of GET parameters.    *
+     * @return: (String): 'all' if it was passed as GET  *
+     *          parameter, 'gm' if it was passed or if   *
+     *          the parameter was not passed, or null if *
+     *          some other value was passed.             *
+     *****************************************************/
+    function get_target($get){
+        $target = $get[GET_TARGET];
+        if (strlen($target) < 1){
+            return DEF_TARGET;
+        }
+        else{
+            if ($target != TARGET_ALL && $target != TARGET_GM){
+                return null;
+            }
+            else{
+                return $target;
+            }
+        }
+    }
+
+    /*****************************************************
+     * Retrieves the notificatios that are still on time *
+     * to be delivered.                                  *
+     *                                                   *
+     * @params:                                          *
+     *    con: (MySQL server connection) Db connector.   *
+     *    target: (String) 'gm' or 'all'.                *
+     * @return: (String): The list of notifications to   *
+     *          be sent to the app, in JSON format, or   *
+     *          null if there are none.                  *
+     *****************************************************/
+    function select_notifications($con, $target){
         if ($target == TARGET_GM){
             $query = "SELECT id, title_es, title_en, title_eu, text_es, text_en, text_eu, dtime, internal AS gm, duration, action, 0 AS seen FROM notification WHERE internal = 1 AND dtime > NOW() - INTERVAL duration MINUTE ORDER BY dtime DESC";
         }
@@ -69,62 +95,47 @@
         }
         $q = mysqli_query($con, $query);
         if (mysqli_num_rows($q) == 0){
-            http_response_code(204);
+            return null;
         }
         else{
-            switch ($format){
-                case FOR_JSON:
-                    //Create result array
-                    $rows = array();
-                    while($r = mysqli_fetch_assoc($q)) {
-                        $rows[] = $r;
-                    }
-                    return(json_encode($rows));
-                    break;
+            $rows = array();
+            while($r = mysqli_fetch_assoc($q)) {
+                $rows[] = $r;
             }
+            return(json_encode($rows));
         }
     }
-    
-    //Connect to the database
-    $con = startdb('rw');
-    
-    //Get data from URL
-    $client = mysqli_real_escape_string($con, $_GET[GET_CLIENT]);
-    $user = mysqli_real_escape_string($con, $_GET[GET_USER]);
-    $target = strtolower(mysqli_real_escape_string($con, $_GET[GET_TARGET]));
-    $format = strtolower(mysqli_real_escape_string($con, $_GET[GET_FORMAT]));
-    
-    //Initialize some variables
-    $error = '';
-    
-    //Validate data
-    if (strlen($client) < 1){
-        $client = '';
-    }
-    if (strlen($user) < 1){
-        $user = '';
-    }
-    if (strlen($target) < 1){
-        $target = DEF_TARGET;
-    }
-    if ($target != TARGET_ALL && $action != TARGET_GM){
-        //Bad request
-        http_response_code(400);
-        $error = $error . ERR_TARGET . mysqli_real_escape_string($con, $_GET[GET_TARGET]);
-    }
-    if (strlen($format) < 1){
-        $format = DEF_FORMAT;
+
+    /*****************************************************
+     * Prints the notifications.                         *
+     *                                                   *
+     * @params:                                          *
+     *    notifications: (String) Notification list, in  *
+     *                   JSON format.                    *
+     *****************************************************/
+    function print_notifications($notifications){
+        print($notifications);
     }
-    if ($format != FOR_JSON){
-        //Bad request
+
+    // Connect to the database
+    $con = startdb('rw');
+
+    // Select target
+    $target = get_target($_GET);
+    if ($target == null){
+        // Bad request
         http_response_code(400);
-        $error = $error . ERR_FORMAT . mysqli_real_escape_string($con, $_GET[GET_FORMAT]);
+        exit(-1);
     }
 
-
-    //If there has not been an error, procede
-    if (strlen($error) == 0){
-        echo(show_notifications($con, $target, $format));
+    // Get notifications
+    $notifications = select_notifications($con, $_GET[GET_TARGET]);
+    if ($notifications == null){
+        // No content
+        http_response_code(204);
+    }
+    else{
+        print_notifications($notifications);
     }
 
 ?>