Update phpdoc, minor formatting

api_gmaps.js

@@ -24,6 +24,7 @@ var popups = new Array();
 var polyOptions;
 var mapOptions;
 var loadedAPI = 'gmaps';
+
 function init() {
   google.maps.visualRefresh = true;
   polyOptions = {
@@ -152,6 +153,7 @@ function addChartEvent(chart) {
     }
   });
 }
+
 //((52.20105108685229, 20.789387865580238), (52.292069558807135, 21.172192736185707))
 function getBounds() {
   var b = map.getBounds().toString();

api_openlayers.js

@@ -27,7 +27,8 @@ var loadedAPI = 'openlayers';
 function init() {
   wgs84 = new OpenLayers.Projection('EPSG:4326');   // from WGS 1984
   mercator = new OpenLayers.Projection('EPSG:900913'); // to Mercator
-  var options = { controls: [
+  var options = {
+    controls: [
       new OpenLayers.Control.ArgParser(), // default
       new OpenLayers.Control.Attribution(), // default
       new OpenLayers.Control.LayerSwitcher(),

changepass.php

@@ -19,9 +19,15 @@
 
   require_once("auth.php"); // sets $mysqli, $user
 
+  /**
+   * Exit with error message
+   *
+   * @param string $errorMessage Message
+   */
   function exitWithError($errorMessage) {
     return exitWithStatus(true, $errorMessage);
   }
+
   /**
    * Exit with xml response
    * @param boolean $isError Error if true

client/index.php

@@ -17,6 +17,12 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * Set response error status and message
+ *
+ * @param array $response Respons
+ * @param string $message Message
+ */
 function setError(&$response, $message) {
   $response['error'] = true;
   $response['message'] = $message;

download.php

@@ -20,6 +20,13 @@
 require_once("auth.php"); // sets $mysqli, $user
 require_once("helpers/position.php");
 
+/**
+ * Add kml marker style element
+ *
+ * @param XMLWriter $xml Writer object
+ * @param string $name Color name
+ * @param string $url Url
+ */
 function addStyle($xml, $name, $url) {
   $xml->startElement("Style");
   $xml->writeAttribute("id", $name."Style");
@@ -32,6 +39,12 @@ function addStyle($xml, $name, $url) {
   $xml->endElement();
 }
 
+/**
+ * Convert seconds to [day], hour, minute, second string
+ *
+ * @param [type] $s Number of seconds
+ * @return string [d ]hhmmss
+ */
 function toHMS($s) {
   $d = floor($s / 86400);
   $h = floor(($s % 86400) / 3600);

helpers/config.php

@@ -17,6 +17,9 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+ /**
+  * Handles config values
+  */
   class uConfig {
     // version number
     static $version = "0.2-beta";
@@ -77,12 +80,18 @@ class uConfig {
     private static $fileLoaded = false;
     public static $rootDir;
 
+   /**
+    * Constructor
+    */
     public function __construct() {
       self::$rootDir = dirname(__DIR__);
       $this->setFromFile();
       $this->setFromCookies();
     }
 
+   /**
+    * Read config values from "/config.php" file
+    */
     private function setFromFile() {
       $configFile = self::$rootDir . "/config.php";
       if (self::$fileLoaded || !file_exists($configFile)) {
@@ -115,6 +124,10 @@ class uConfig {
         self::$public_tracks = true;
       }
     }
+
+   /**
+    * Read config values stored in cookies
+    */
     private function setFromCookies() {
       if (isset($_COOKIE["ulogger_api"])) { self::$mapapi = $_COOKIE["ulogger_api"]; }
       if (isset($_COOKIE["ulogger_lang"])) { self::$lang = $_COOKIE["ulogger_lang"]; }

helpers/db.php

@@ -18,11 +18,26 @@
  */
 
   require_once (__DIR__ . "/config.php");
+
+ /**
+  * mysqli wrapper
+  */
   class uDb extends mysqli {
-  // singleton instance
+    /**
+     * Singleton instance
+     *
+     * @var mysqli Object instance
+     */
     protected static $instance;
 
-  // private constuctor
+   /**
+    * Private constuctor
+    *
+    * @param string $host
+    * @param string $user
+    * @param string $pass
+    * @param string $name
+    */
     private function __construct($host, $user, $pass, $name) {
       parent::__construct($host, $user, $pass, $name);
       if ($this->connect_error) {
@@ -35,7 +50,9 @@ class uDb extends mysqli {
       $this->set_charset('utf8');
     }
 
-  // returns singleton instance
+   /**
+    * Returns singleton instance
+    */
     public static function getInstance() {
       if (!self::$instance) {
         $config = new uConfig();

helpers/position.php

@@ -19,6 +19,9 @@
 
   require_once(__DIR__ . "/db.php");
 
+ /**
+  * Positions handling
+  */
   class uPosition {
     public $id;
     public $time;
@@ -40,6 +43,10 @@ class uPosition {
 
     private static $db;
 
+   /**
+    * Constructor
+    * @param integer $positionId Position id
+    */
     public function __construct($positionId = NULL) {
 
       self::$db = uDB::getInstance();
@@ -57,6 +64,23 @@ class uPosition {
       }
     }
 
+   /**
+    * Add position
+    *
+    * @param int $userId
+    * @param int $trackId
+    * @param int $time Unix time stamp
+    * @param double $lat
+    * @param double $lon
+    * @param double $altitude
+    * @param double $speed
+    * @param double $bearing
+    * @param int $accuracy
+    * @param string $provider
+    * @param string $comment
+    * @param int $imageId
+    * @return int|bool New position id in database, false on error
+    */
     public function add($userId, $trackId, $time, $lat, $lon, $altitude, $speed, $bearing, $accuracy, $provider, $comment, $imageId) {
       $positionId = false;
       if (!is_null($lat) && !is_null($lon) && !is_null($time) && !empty($userId) && !empty($trackId)) {
@@ -77,6 +101,12 @@ class uPosition {
       return $positionId;
     }
 
+   /**
+    * Fill class properties with last position data from database
+    * (for given user if specified)
+    *
+    * @param int $userId Optional user id
+    */
     public function getLast($userId = NULL) {
       if (!empty($userId)) {
         $where = "WHERE p.user_id = ?";
@@ -96,6 +126,13 @@ class uPosition {
       $this->loadWithQuery($query, $params);
     }
 
+   /**
+    * Get array of all positions
+    *
+    * @param int $userId Optional limit to given user id
+    * @param int $trackId Optional limit to given track id
+    * @return array|bool Array of uPosition positions, false on error
+    */
     public function getAll($userId = NULL, $trackId = NULL) {
       $rules = [];
       if (!empty($userId)) {
@@ -129,7 +166,12 @@ class uPosition {
       return $positionsArr;
     }
 
-    // haversine distance to target point
+   /**
+    * Calculate distance to target point using haversine formula
+    *
+    * @param uPosition $target Target position
+    * @return int Distance in meters
+    */
     public function distanceTo($target) {
       $lat1 = deg2rad($this->latitude);
       $lon1 = deg2rad($this->longitude);
@@ -141,10 +183,22 @@ class uPosition {
       return $bearing * 6371000;
     }
 
+   /**
+    * Calculate time elapsed since target point
+    *
+    * @param uPosition $target Target position
+    * @return int Number of seconds
+    */
     public function secondsTo($target) {
       return strtotime($this->time) - strtotime($target->time);
     }
 
+   /**
+    * Convert database row to uPosition
+    *
+    * @param array $row Row
+    * @return uPosition Position
+    */
     private function rowToObject($row) {
       $position = new uPosition();
       $position->id = $row['id'];
@@ -166,6 +220,12 @@ class uPosition {
       return $position;
     }
 
+   /**
+    * Fill class properties with database query result
+    *
+    * @param string $query Query
+    * @param array|null $bindParams Optional array of bind parameters (types, params)
+    */
     private function loadWithQuery($query, $bindParams = NULL) {
       $stmt = self::$db->prepare($query);
       if (is_array($bindParams) && ($types = array_shift($bindParams))) {

helpers/track.php

@@ -19,6 +19,9 @@
 
   require_once(__DIR__ . "/db.php");
 
+ /**
+  * Track handling
+  */
   class uTrack {
     public $id;
     public $userId;
@@ -29,6 +32,11 @@ class uTrack {
 
     private static $db;
 
+   /**
+    * Constructor
+    *
+    * @param int $trackId Track id
+    */
     public function __construct($trackId = NULL) {
 
       self::$db = uDB::getInstance();
@@ -46,6 +54,14 @@ class uTrack {
       }
     }
 
+   /**
+    * Add new track
+    *
+    * @param string $userId User id
+    * @param string $name Name
+    * @param string $comment Optional comment
+    * @return int|bool New track id, false on error
+    */
     public function add($userId, $name, $comment = NULL) {
       $trackId = false;
       if (!empty($userId) && !empty($name)) {
@@ -61,6 +77,12 @@ class uTrack {
       return $trackId;
     }
 
+   /**
+    * Get all tracks
+    *
+    * @param int $userId Optional limit to user id
+    * @return array|bool Array of uTrack tracks, false on error
+    */
     public function getAll($userId = NULL) {
       if (!empty($userId)) {
         $where = "WHERE user_id='" . self::$db->real_escape_string($userId) ."'";
@@ -80,6 +102,12 @@ class uTrack {
       return $trackArr;
     }
 
+   /**
+    * Convert database row to uTrack
+    *
+    * @param array $row Row
+    * @return uTrack Track
+    */
     private function rowToObject($row) {
       $track = new uTrack();
       $track->id = $row['id'];

helpers/user.php

@@ -16,10 +16,12 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
-
   require_once (__DIR__ . "/config.php");
   require_once (__DIR__ . "/db.php");
 
+ /**
+  * User handling routines
+  */
   class uUser {
     public $id;
     public $login;
@@ -29,6 +31,11 @@ class uUser {
 
     private static $db;
 
+   /**
+    * Constructor
+    *
+    * @param string $login Login
+    */
     public function __construct($login = NULL) {
       self::$db = uDB::getInstance();
       if (!empty($login)) {
@@ -44,6 +51,13 @@ class uUser {
       }
     }
 
+   /**
+    * Add new user
+    *
+    * @param string $login Login
+    * @param string $hash Password hash
+    * @return int|bool New user id, false on error
+    */
     public function add($login, $hash) {
       $userid = false;
       if (!empty($login) && !empty($hash)) {
@@ -59,6 +73,12 @@ class uUser {
       return $userid;
     }
 
+   /**
+    * Set user password
+    *
+    * @param string $hash Hash
+    * @return bool True on success, false otherwise
+    */
     public function setPass($hash) {
       $ret = false;
       $sql = "UPDATE users SET password = ? WHERE login = ?";
@@ -72,14 +92,26 @@ class uUser {
       return $ret;
     }
 
+   /**
+    * Check if given password matches user's one
+    *
+    * @param String $password Password
+    * @return bool True if matches, false otherwise
+    */
     public function validPassword($password) {
       return password_verify($password, $this->hash);
     }
 
+   /**
+    * Store uUser object in session
+    */
     public function storeInSession() {
       $_SESSION['user'] = $this;
     }
 
+   /**
+    * Fill uUser object properties from session data
+    */
     public function getFromSession() {
       if (isset($_SESSION['user'])) {
         $sessionUser = $_SESSION['user'];
@@ -91,6 +123,11 @@ class uUser {
       }
     }
 
+   /**
+    * Get all users
+    *
+    * @return array|bool Array of uUser users, false on error
+    */
     public function getAll() {
       $query = "SELECT id, login, password FROM users ORDER BY login";
       $result = self::$db->query($query);
@@ -105,6 +142,12 @@ class uUser {
       return $userArr;
     }
 
+   /**
+    * Convert database row to uUser
+    *
+    * @param array $row Row
+    * @return uUser User
+    */
     private function rowToObject($row) {
       $user = new uUser();
       $user->id = $row['id'];
@@ -115,10 +158,15 @@ class uUser {
       return $user;
     }
 
+   /**
+    * Is given login admin user
+    *
+    * @param string $login Login
+    * @return bool True if admin, false otherwise
+    */
     private function isAdmin($login) {
       $config = new uConfig();
       return (!empty($config::$admin_user) && $config::$admin_user == $login);
     }
   }
-
 ?>

lang/pl.php

@@ -17,7 +17,6 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
-
 $lang["title"] = "• μlogger •";
 $lang["private"] = "Aby się zalogować musisz podać login i hasło";
 $lang["authfail"] = "błędny login lub hasło";

logout.php

@@ -27,4 +27,5 @@ session_destroy();
 $ssl = ((!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == "" || $_SERVER['HTTPS'] == "off") ? "http" : "https");
 $url = str_replace("//", "/", $_SERVER['HTTP_HOST'].dirname($_SERVER['SCRIPT_NAME'])."/index.php");
 header("Location: $ssl://$url");
+
 ?>

main.js

@@ -178,6 +178,18 @@ function getPopupHtml(p, i, count) {
   } else if (p.provider == 'network') {
     provider = ' (<img class="icon" alt="' + lang['network'] + '" title="' + lang['network'] + '"  src="images/network_dark.svg" />)';
   }
+  var stats = '';
+  if (latest == 0) {
+    stats =
+      '<div id="pright">' +
+      '<img class="icon" src="images/stats_blue.svg" style="padding-left: 3em;" /><br />' +
+      '<img class="icon" alt="' + lang['ttime'] + '" title="' + lang['ttime'] + '" src="images/time_blue.svg" /> ' +
+      p.totalSeconds.toHMS() + '<br />' +
+      '<img class="icon" alt="' + lang['aspeed'] + '" title="' + lang['aspeed'] + '" src="images/speed_blue.svg" /> ' +
+      ((p.totalSeconds > 0) ? ((p.totalMeters / p.totalSeconds).toKmH() * factor_kmh).toFixed() : 0) + ' ' + unit_kmh + '<br />' +
+      '<img class="icon" alt="' + lang['tdistance'] + '" title="' + lang['tdistance'] + '" src="images/distance_blue.svg" /> ' +
+      (p.totalMeters.toKm() * factor_km).toFixed(2) + ' ' + unit_km + '<br />' + '</div>';
+  }
   popup =
     '<div id="popup">' +
     '<div id="pheader">' +
@@ -189,18 +201,14 @@ function getPopupHtml(p, i, count) {
     '<div id="pleft">' +
     '<img class="icon" alt="' + lang['time'] + '" title="' + lang['time'] + '" src="images/calendar_dark.svg" /> ' + date + '<br />' +
     '<img class="icon" alt="' + lang['time'] + '" title="' + lang['time'] + '" src="images/clock_dark.svg" /> ' + time + '<br />' +
-  ((p.speed != null)?'<img class="icon" alt="'+lang['speed']+'" title="'+lang['speed']+'" src="images/speed_dark.svg" /> '+(p.speed.toKmH()*factor_kmh)+' '+unit_kmh+'<br />':'')+
+    ((p.speed != null) ? '<img class="icon" alt="' + lang['speed'] + '" title="' + lang['speed'] + '" src="images/speed_dark.svg" /> ' +
-  ((p.altitude != null)?'<img class="icon" alt="'+lang['altitude']+'" title="'+lang['altitude']+'" src="images/altitude_dark.svg" /> '+(p.altitude*factor_m).toFixed()+' '+unit_m+'<br />':'')+
+    (p.speed.toKmH() * factor_kmh) + ' ' + unit_kmh + '<br />' : '') +
-  ((p.accuracy != null)?'<img class="icon" alt="'+lang['accuracy']+'" title="'+lang['accuracy']+'" src="images/accuracy_dark.svg" /> '+(p.accuracy*factor_m).toFixed()+' '+unit_m+provider+'<br />':'')+
+    ((p.altitude != null) ? '<img class="icon" alt="' + lang['altitude'] + '" title="' + lang['altitude'] + '" src="images/altitude_dark.svg" /> ' +
+    (p.altitude * factor_m).toFixed() + ' ' + unit_m + '<br />' : '') +
+    ((p.accuracy != null) ? '<img class="icon" alt="' + lang['accuracy'] + '" title="' + lang['accuracy'] + '" src="images/accuracy_dark.svg" /> ' +
+    (p.accuracy * factor_m).toFixed() + ' ' + unit_m + provider + '<br />' : '') +
     '</div>' +
-  ((latest==0)?
+    stats +
-  ('<div id="pright">'+
-  '<img class="icon" src="images/stats_blue.svg" style="padding-left: 3em;" /><br />'+
-  '<img class="icon" alt="'+lang['ttime']+'" title="'+lang['ttime']+'" src="images/time_blue.svg" /> '+p.totalSeconds.toHMS()+'<br />'+
-  '<img class="icon" alt="'+lang['aspeed']+'" title="'+lang['aspeed']+'" src="images/speed_blue.svg" /> '+((p.totalSeconds>0)?((p.totalMeters/p.totalSeconds).toKmH()*factor_kmh).toFixed():0)+' '+unit_kmh+'<br />'+
-  '<img class="icon" alt="'+lang['tdistance']+'" title="'+lang['tdistance']+'" src="images/distance_blue.svg" /> '+(p.totalMeters.toKm()*factor_km).toFixed(2)+' '+unit_km+'<br />'+'</div>')
-  :
-  '')+
     '<div id="pfooter">' + lang['point'] + ' ' + (i + 1) + ' ' + lang['of'] + ' ' + count + '</div>' +
     '</div></div>';
   return popup;
@@ -227,7 +235,6 @@ function getNode(p,name) {
   return ((p.getElementsByTagName(name)[0].childNodes[0]) ? p.getElementsByTagName(name)[0].childNodes[0].nodeValue : null);
 }
 
-
 // seconds to (d) H:M:S
 Number.prototype.toHMS = function () {
   var s = this;
@@ -238,10 +245,12 @@ Number.prototype.toHMS = function(){
 
   return ((d > 0) ? (d + ' d ') : '') + (('00' + h).slice(-2)) + ':' + (('00' + m).slice(-2)) + ':' + (('00' + s).slice(-2)) + '';
 }
+
 // meters to km
 Number.prototype.toKm = function () {
   return Math.round(this / 10) / 100;
 }
+
 // m/s to km/h
 Number.prototype.toKmH = function () {
   return Math.round(this * 3600 / 10) / 100;
@@ -369,6 +378,7 @@ function loadMapAPI(api) {
   addScript(url[0]);
   waitAndLoad(api, url);
 }
+
 var loadTime = 0;
 function waitAndLoad(api, url) {
   // wait till first script loaded